On Wed, Sep 29, 2010 at 3:43 PM, Martin Pool <email address hidden> wrote:
> No, I meant that I thought the Python convention was that docstrings
> should be a single sentence that fits on a single line, such as
>
> """General Python convenience functions.
> """
I may be misunderstanding, but that particular layout really squicks.
"""General Python convenience functions."""
or
"""General Python convenience functions.
More detail here.
"""
> Perhaps it doesn't matter if it's on one line and it just needs to be
> a single-sentence paragraph?
On Wed, Sep 29, 2010 at 3:43 PM, Martin Pool <email address hidden> wrote:
> No, I meant that I thought the Python convention was that docstrings
> should be a single sentence that fits on a single line, such as
>
> """General Python convenience functions.
> """
I may be misunderstanding, but that particular layout really squicks.
"""General Python convenience functions."""
or
"""General Python convenience functions.
More detail here.
"""
> Perhaps it doesn't matter if it's on one line and it just needs to be
> a single-sentence paragraph?
http:// www.python. org/dev/ peps/pep- 0257/
"The closing quotes are on the same line as the opening quotes. This
looks better for one-liners."
etc.
_Rob