Merge pull request #300 from WarrenWeckesser/long-see-also-entry

Add a note to the docstring standard about long 'See Also' entries.

1 files changed, 10 insertions, 0 deletions

diff --git a/doc/format.rst b/doc/format.rst
index 788126f..3c60b90 100644
--- a/doc/format.rst
+++ b/doc/format.rst
@@ -329,6 +329,16 @@ The sections of a function's docstring are:
       func_b, func_c_, func_d
       func_e
 
+    If the combination of the function name and the description creates
+    a line that is too long, the entry may be written as two lines, with
+    the function name and colon on the first line, and the description
+    on the next line, indented four spaces::
+
+      See Also
+      --------
+      package.module.submodule.func_a :
+          A somewhat long description of the function.
+
 13. **Notes**
 
     An optional section that provides additional information about the