Skip to content

document default values as part of the type spec #289

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 3 commits into from
Jan 9, 2021
Merged

document default values as part of the type spec #289

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e428092
mention the option to document default values in the type spec
keewis Jul 29, 2020
d09324e
Commit doc suggestion that "default" is used instead of "optional"
rgommers Jan 1, 2021
4ca0f96
show multiple different versions of the default syntax
keewis Jan 5, 2021
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
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 @@ -197,6 +197,13 @@ The sections of a function's docstring are:
Description of parameter `x` (the default is -1, which implies summation
over all axes).

or as part of the type, instead of ``optional``. If the default value would not be
used as a value, ``optional`` is preferred. These are all equivalent::

copy : bool, default True
copy : bool, default=True
copy : bool, default: True

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