Skip to content
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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions doc/source/examples/tools_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor Author

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



I entered the wrong information in my config file so it always loads incorrect information, how do I fix that?
Expand Down
4 changes: 2 additions & 2 deletions doc/source/utilities/tools_utility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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.

Expand Down
Loading