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

DOC: include positional-only and keyword-only parameters in standard #367

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

DOC: include positional-only and keyword-only parameters in standard #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9062e84
DOC: include keyword-only parameters in standard
namurphy Mar 2, 2022
a28dd35
DOC: add example combining keyword-only & optional
namurphy Mar 2, 2022
c8b0542
DOC: include positional-only parameters in standard
namurphy Mar 2, 2022
6b65b19
DOC: add example for keyword-only parameter
namurphy Mar 2, 2022
461eec4
Expand numpydoc_xref_ignore in install.rst
namurphy May 10, 2022
ad070da
Expand numpydoc_xref_ignore in doc/conf.py
namurphy May 10, 2022
d51e929
Merge branch 'main' of github.com:numpy/numpydoc into keyword-only-pa…
namurphy Aug 12, 2022
df1c230
Merge branch 'main' into keyword-only-parameters
namurphy Dec 28, 2023
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
9 changes: 8 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,14 @@
# master_doc = "index" # NOTE: will be changed to `root_doc` in sphinx 4

numpydoc_xref_param_type = True
numpydoc_xref_ignore = {"optional", "type_without_description", "BadException"}
numpydoc_xref_ignore = {
"optional",
"type_without_description",
"BadException",
"keyword-only",
"positional-only",
}

# Run docstring validation as part of build process
numpydoc_validation_checks = {"all", "GL01", "SA04", "RT03"}

Expand Down
7 changes: 7 additions & 0 deletions doc/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,13 @@ used as a value, ``optional`` is preferred. These are all equivalent::
copy : bool, default=True
copy : bool, default: True

Use ``positional-only`` for positional-only parameters, and ``keyword-only``
for keyword-only parameters::

x : int, positional-only
y : int, keyword-only
z : int, keyword-only, optional

When a parameter can only assume one of a fixed set of values,
those values can be listed in braces, with the default appearing first::

Expand Down
2 changes: 1 addition & 1 deletion doc/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ numpydoc_xref_ignore : set or ``"all"``
used in parameter type descriptions that may be confused for
classes of the same name. For example::

numpydoc_xref_ignore = {'type', 'optional', 'default'}
numpydoc_xref_ignore = {'type', 'optional', 'default', 'keyword-only', 'positional-only'}

The default is an empty set.

Expand Down
Loading