Skip to content

Commit 180a924

Browse files
authored
Merge pull request #300 from WarrenWeckesser/long-see-also-entry
Add a note to the docstring standard about long 'See Also' entries.
2 parents 05e5c2b + 651edbd commit 180a924

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/format.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,16 @@ The sections of a function's docstring are:
329329
func_b, func_c_, func_d
330330
func_e
331331

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+
332342
13. **Notes**
333343

334344
An optional section that provides additional information about the

0 commit comments

Comments
 (0)