add docs for check_and_build_global_config()
#270
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yucongalicechen
commented
Dec 23, 2024
| @@ -95,12 +96,32 @@ it will only run once. However, if you want to bypass this behavior, | |||
| ``check_and_build_global_config()`` takes an optional boolean ``skip_config_creation`` parameter that | |||
| could be set to ``True`` at runtime to override the config creation. | |||
|
|
|||
| What happens when you run ``check_and_build_global_config()``? | |||
There was a problem hiding this comment.
add example
yucongalicechen
commented
Dec 23, 2024
| @@ -111,7 +132,7 @@ Locate the file ``diffpyconfig.json``, in your home directory and open it in an | |||
| "owner_orcid": "0000-0000-4321-1234" | |||
| } | |||
|
|
|||
| Then you can edit the username and email as needed, make sure to save your edits. | |||
| Then you can edit the username and email as needed, make sure to save your edits. | |||
yucongalicechen
commented
Dec 23, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #270 +/- ##
=======================================
Coverage 98.68% 98.68%
=======================================
Files 8 8
Lines 379 379
=======================================
Hits 374 374
Misses 5 5 |
yucongalicechen
commented
Dec 23, 2024
|
|
||
|
|
||
| def stringify(obj): | ||
| def _stringify(obj): |
There was a problem hiding this comment.
make this function private and remove unncessary functions
sbillinge
reviewed
Dec 23, 2024
| After receiving the inputs, the function will write the following to the file: | ||
|
|
||
| .. code-block:: python | ||
| {"owner_name": "Jane Doe", "owner_email": "[email protected]", "owner_orcid": "0000-0000-0000-0000"} |
| Please enter your orcid ID if you know it: 0000-0000-0000-0000 | ||
|
|
||
|
|
||
| After receiving the inputs, the function will write the following to the file: |
There was a problem hiding this comment.
Maybe ".... the diffpyconfig.json file in the users home directory"?
On the one hand it is a bit repetitive (also did elsewhere), but maybe it is better to be clear?
| Developers can use this function to simplify the process of loading, merging, and saving information consistently and easily. | ||
| Additionally, it saves the effort of re-entering information, and allows overriding current information by | ||
| passing parameters. | ||
|
|
||
| - ``check_and_build_global_config()``: This function helps create a global configuration file | ||
| that can be used by ``get_user_info()``. |
There was a problem hiding this comment.
Maybe say, "...used by, for example, get_user_info()..."
It could also be used by some other user written function
| Developers can use this function to simplify the process of loading, merging, and saving information consistently and easily. | ||
| Additionally, it saves the effort of re-entering information, and allows overriding current information by | ||
| passing parameters. | ||
|
|
||
| - ``check_and_build_global_config()``: This function helps create a global configuration file | ||
| that can be used by ``get_user_info()``. | ||
| If no existing configuration file is found, and the user allows inputs, this function prompts for information. |
There was a problem hiding this comment.
I think "user allows inputs" is confusing so I recommend to delete that.
yucongalicechen
commented
Dec 23, 2024
| .. code-block:: python | ||
| {"owner_name": "Jane Doe", "owner_email": "[email protected]", "owner_orcid": "0000-0000-0000-0000"} | ||
| After receiving the inputs, the function will write the information to | ||
| the `diffpyconfig.json` file in your home directory. |
There was a problem hiding this comment.
I deleted the example here - there are examples both before and after this section
yucongalicechen
commented
Dec 23, 2024
| that can be used by ``get_user_info()``. | ||
| If no existing configuration file is found, and the user allows inputs, this function prompts for information. | ||
| that can be used by, for example, ``get_user_info()``. | ||
| If no existing configuration file is found, this function prompts for information. |
There was a problem hiding this comment.
deleted "allows inputs"
|
@sbillinge ready for review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #268
@sbillinge ready for review