[Python-Dev] Reminder: an oft-forgotten rule about docstring formatting (PEP 257) (original) (raw)
Terry Reedy tjreedy at udel.edu
Sat Jun 29 00:45:06 CEST 2013
- Previous message: [Python-Dev] Reminder: an oft-forgotten rule about docstring formatting (PEP 257)
- Next message: [Python-Dev] Classes with ordered namespaces
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
On 6/26/2013 9:56 PM, Guido van Rossum wrote:
PEP 257 says this on the formatting of multi-line docstrings:
""" Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description.
fileinput has docstrings like
"""
Return the file number of the current file. When no file is currently
opened, returns -1.
"""and, perhaps neater, """ Return the name of the file currently being read. Before the first line has been read, returns None. """
From the above, I presume these should become
"""
Return the file number of the current file.
When no file is currently opened, returns -1.
"""and """ Return the name of the file currently being read.
Before the first line has been read, returns None.
"""-- Terry Jan Reedy
- Previous message: [Python-Dev] Reminder: an oft-forgotten rule about docstring formatting (PEP 257)
- Next message: [Python-Dev] Classes with ordered namespaces
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]