Skip to content

Commit 9cb2df5

Browse files
committed
deploy: 8baba3b
1 parent cdd7bff commit 9cb2df5

File tree

4 files changed

+19
-22
lines changed

4 files changed

+19
-22
lines changed

_sources/utilities/toolsutility.rst.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ Tools Utility
77

88
The ``diffpy.utils.tools`` module provides tool functions for use with diffpy apps.
99

10-
1) ``get_uder_info``: This function is designed for managing and tracking username and email information.
10+
1) ``get_user_info``: This function is designed for managing and tracking username and email information.
1111

12-
Developers can use this function to simplify the process of loading, merging, and saving information consistently and easily.
13-
Additionally, it saves the effort of re-entering information, and allows overriding current information by
14-
passing parameters.
12+
Developers can use this function to simplify the process of loading, merging, and saving information consistently and easily.
13+
Additionally, it saves the effort of re-entering information, and allows overriding current information by
14+
passing parameters.
1515

1616
2) ``get_package_info``: This function loads package name and version information into a dictionary.
17-
It updates the package information under the key "package_info" in the format {"package_name": "version_number"},
18-
resulting in an entry in the passed metadata dictionary that looks like
19-
`{"package_info": {"package1": "version_number1", "package2": "version_number2"} if the function is called more than
20-
once.
17+
It updates the package information under the key "package_info" in the format {"package_name": "version_number"},
18+
resulting in an entry in the passed metadata dictionary that looks like
19+
``{"package_info": {"package1": "version_number1", "package2": "version_number2"}`` if the function is called more than
20+
once.
2121

22-
Users can use these functions to track and manage versions of packages that can later be stored, for example, in an output
23-
file header.
22+
Users can use these functions to track and manage versions of packages that can later be stored, for example, in an output
23+
file header.

api/diffpy.utils.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
120120
</section>
121121
<section id="module-diffpy.utils.version">
122122
<span id="diffpy-utils-version-module"></span><h2>diffpy.utils.version module<a class="headerlink" href="#module-diffpy.utils.version" title="Link to this heading"></a></h2>
123-
<p>Definition of __version__, __date__, __timestamp__, __git_commit__.</p>
124-
<section id="notes">
125-
<h3>Notes<a class="headerlink" href="#notes" title="Link to this heading"></a></h3>
126-
<p>Variable <cite>__gitsha__</cite> is deprecated as of version 3.0.
127-
Use <cite>__git_commit__</cite> instead.</p>
128-
</section>
123+
<p>Definition of __version__.</p>
129124
</section>
130125
</section>
131126

0 commit comments

Comments
 (0)