Skip to content
Merged
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": "janedoe@email.com", "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?
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
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.
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