Skip to content

Commit 7fe8d7b

Browse files
echedey-lscwhanse
andauthored
Apply suggestions from Cliff
Co-authored-by: Cliff Hansen <[email protected]>
1 parent e2c6e7f commit 7fe8d7b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/sphinx/source/contributing/style_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ required for every function.
121121
def example_function(poa_global, exponents, degree_symbol, time_ref='UT',
122122
optional_arg=None):
123123
r"""
124-
Brief summary of the function (no citations).
124+
One-sentence summary of the function (no citations).
125125
126126
A longer description of the function. This can include citations
127127
(references) to literature [1]_, websites [2]_, and other code elements
@@ -215,7 +215,7 @@ A preview of how this docstring would render in the documentation can be seen in
215215
following file: :download:`Example docstring<../_images/example_function_screenshot.png>`.
216216

217217
Remember that to show the docstring in the documentation, you must list
218-
the function in the appropriate ``.rst`` file in the ``docs/sphinx/source/reference`` file.
218+
the function in the appropriate ``.rst`` file in the ``docs/sphinx/source/reference`` folder.
219219

220220
.. _example-gallery:
221221

0 commit comments

Comments
 (0)