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.
2 parents 05e5c2b + 651edbd commit 180a924Copy full SHA for 180a924
doc/format.rst
@@ -329,6 +329,16 @@ The sections of a function's docstring are:
329
func_b, func_c_, func_d
330
func_e
331
332
+ If the combination of the function name and the description creates
333
+ a line that is too long, the entry may be written as two lines, with
334
+ the function name and colon on the first line, and the description
335
+ on the next line, indented four spaces::
336
+
337
+ See Also
338
+ --------
339
+ package.module.submodule.func_a :
340
+ A somewhat long description of the function.
341
342
13. **Notes**
343
344
An optional section that provides additional information about the
0 commit comments