Skip to content

[DOC]: Add docstring example to the contributing docs #2254

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.

Sign up for GitHub

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

Merged
merged 13 commits into from
Oct 31, 2024
Merged

[DOC]: Add docstring example to the contributing docs #2254

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0754056
Add docstring example
echedey-ls Oct 11, 2024
595ce25
Update style_guide.rst
echedey-ls Oct 18, 2024
fc1159b
Update style_guide.rst
echedey-ls Oct 18, 2024
8f7158c
Update style_guide.rst
echedey-ls Oct 19, 2024
b3e3f64
Update example_function_screenshot.png
echedey-ls Oct 19, 2024
f190adf
Double check parameters
echedey-ls Oct 21, 2024
e1b25d3
datatypes
echedey-ls Oct 22, 2024
8d1a3d2
Update interactive example
echedey-ls Oct 22, 2024
d5f95f3
Update example_function_screenshot.png
echedey-ls Oct 22, 2024
a1caab1
Add some little code to example
echedey-ls Oct 22, 2024
e2c6e7f
Update v0.11.2.rst
echedey-ls Oct 22, 2024
7fe8d7b
Apply suggestions from Cliff
echedey-ls Oct 22, 2024
5e8df69
Update example_function_screenshot.png
echedey-ls Oct 22, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from Cliff 
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
  • Loading branch information
@echedey-ls @cwhanse
echedey-ls and cwhanse authored Oct 22, 2024
commit 7fe8d7bfdb3f99a7c72e38db71933d2c068835b0
4 changes: 2 additions & 2 deletions docs/sphinx/source/contributing/style_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ required for every function.
def example_function(poa_global, exponents, degree_symbol, time_ref='UT',
optional_arg=None):
r"""
Brief summary of the function (no citations).
One-sentence summary of the function (no citations).

A longer description of the function. This can include citations
(references) to literature [1]_, websites [2]_, and other code elements
Expand Down Expand Up @@ -215,7 +215,7 @@ A preview of how this docstring would render in the documentation can be seen in
following file: :download:`Example docstring<../_images/example_function_screenshot.png>`.

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

.. _example-gallery:

Expand Down
Loading