Meet docstring standards
frankie.onuonga at gmail.com
Fri Sep 13 21:31:34 UTC 2013
On Thu, Sep 12, 2013 at 10:29 AM, Miroslav Suchý <msuchy at redhat.com> wrote:
> On 09/12/2013 11:04 AM, Pierre-Yves Chibon wrote:
>> class ProductionConfig(Config):
>>> >- """Production Environment: The environmental values which are set
>>> for a machine that is being used in production. This disables the machine
>>> from displaying errors and warnings. Secret keys, backend passwords and the
>>> path/location to the database is also set here"""
>>> >+ """Production Environment: The environmental values which are set
>>> for a\
>>> >+ machine that is being used in production. \
>>> >+ This disables the machine from displaying errors and warnings. \
>>> >+ Secret keys, backend passwords and the path or location to the \
>>> >+ database is also set here"""
>> If I like having lines below 80 characters, I disagree with the use of
>> '\' in
> I had used multilines cause of coding standards at pep8. I think not more
than 75 characters a line.
Kindly do advice on what rule of thumb we should follow for us.
I am not too sure what to use instead of the "\" . Kindly do advice on that.
Also thank you so much for being such a great team.
> When generating the documentation using sphinx or something else, they
>> will most
>> likely appear and they just decrease the readibility (at least imo).
> Agree. Multiline docstring count with multilines, so there is no need to
> put backslash at the end.
> Miroslav Suchy, RHCE, RHCDS
> Red Hat, Software Engineer, #brno, #devexp, #fedora-buildsys
> copr-devel mailing list
> copr-devel at lists.fedorahosted.**org <copr-devel at lists.fedorahosted.org>
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the copr-devel