Skip to content

Commit 13742d0

Browse files
edit docs
1 parent cc8cf05 commit 13742d0

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

doc/source/examples/tools_example.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,8 @@ An example of the prompts you may see is:
110110
Please enter your orcid ID if you know it: 0000-0000-0000-0000
111111
112112
113-
After receiving the inputs, the function will write the following to the file:
114-
115-
.. code-block:: python
116-
{"owner_name": "Jane Doe", "owner_email": "janedoe@email.com", "owner_orcid": "0000-0000-0000-0000"}
113+
After receiving the inputs, the function will write the information to
114+
the `diffpyconfig.json` file in your home directory.
117115

118116

119117
I entered the wrong information in my config file so it always loads incorrect information, how do I fix that?

doc/source/utilities/tools_utility.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ The ``diffpy.utils.tools`` module provides tool functions for use with diffpy ap
1111
passing parameters.
1212

1313
- ``check_and_build_global_config()``: This function helps create a global configuration file
14-
that can be used by ``get_user_info()``.
15-
If no existing configuration file is found, and the user allows inputs, this function prompts for information.
14+
that can be used by, for example, ``get_user_info()``.
15+
If no existing configuration file is found, this function prompts for information.
1616
The provided inputs are then saved to a global configuration file.
1717
This file can be reused later by ``get_user_info()`` to ensure that the work credits and user information are consistently stored.
1818

0 commit comments

Comments
 (0)