We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 2e76685 commit af154f4Copy full SHA for af154f4
doc/format.rst
@@ -197,6 +197,13 @@ The sections of a function's docstring are:
197
Description of parameter `x` (the default is -1, which implies summation
198
over all axes).
199
200
+ or as part of the type, instead of ``optional``. If the default value would not be
201
+ used as a value, ``optional`` is preferred. These are all equivalent::
202
+
203
+ copy : bool, default True
204
+ copy : bool, default=True
205
+ copy : bool, default: True
206
207
When a parameter can only assume one of a fixed set of values,
208
those values can be listed in braces, with the default appearing first::
209
0 commit comments