Meet docstring standards
Miroslav Suchý
msuchy at redhat.com
Thu Sep 12 09:29:38 UTC 2013
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
> documentation.
> 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
More information about the copr-devel
mailing list