Skip to content
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

Jump to bottom

updating style doc for list parameter #200

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

updating style doc for list parameter #200

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ab1631
updating style doc for list parameter
robotjellyzone Apr 14, 2022
101b8b0
adding note suggesting to follow type hint
robotjellyzone Apr 16, 2022
71d8f1f
fixed note
robotjellyzone Apr 17, 2022
6588576
fixed note section & added name in authors
robotjellyzone Apr 18, 2022
e8fa25d
Merge branch 'develop' into style_doc_list
RMeli Mar 4, 2024
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: 5 additions & 1 deletion doc/source/contributing_code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ A typical function docstring looks like the following:

::

def func(arg1, arg2):
def func(arg1, arg2, arg3):
"""Summary line.

Extended description of function.
Expand All @@ -615,6 +615,8 @@ A typical function docstring looks like the following:
Description of `arg1`
arg2 : str
Description of `arg2`
arg3 : list[int]
Description of `arg3`


Returns
Expand All @@ -625,6 +627,8 @@ A typical function docstring looks like the following:
"""
return True

Notes: Functions should consistently follow the type hinting recommendations throughout by following `type hinting pep-0484 <https://www.python.org/dev/peps/pep-0484/>`_
robotjellyzone marked this conversation as resolved.
Show resolved Hide resolved

robotjellyzone marked this conversation as resolved.
Show resolved Hide resolved
.. seealso::

The `napoleon documentation <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html>`_ has further breakdowns of docstrings at the module, function, class, method, variable, and other levels.
Expand Down