-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add docs for check_and_build_global_config()
#270
Open
yucongalicechen
wants to merge
5
commits into
diffpy:main
Choose a base branch
from
yucongalicechen:user-info2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+57
−55
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -110,10 +110,8 @@ An example of the prompts you may see is: | |
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: | ||
|
||
.. 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. | ||
|
||
|
||
I entered the wrong information in my config file so it always loads incorrect information, how do I fix that? | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,8 +11,8 @@ The ``diffpy.utils.tools`` module provides tool functions for use with diffpy ap | |
passing parameters. | ||
|
||
- ``check_and_build_global_config()``: This function helps create a global configuration file | ||
yucongalicechen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. deleted "allows inputs" |
||
The provided inputs are then saved to a global configuration file. | ||
This file can be reused later by ``get_user_info()`` to ensure that the work credits and user information are consistently stored. | ||
|
||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I deleted the example here - there are examples both before and after this section