Meet docstring standards

Frankie Onuonga frankie.onuonga at gmail.com
Sat Sep 14 06:20:34 UTC 2013


On Fri, Sep 13, 2013 at 11:17 PM, Toshio Kuratomi <a.badger at gmail.com>wrote:

>
> On Sep 13, 2013 2:31 PM, "Frankie Onuonga" <frankie.onuonga at gmail.com>
> wrote:
> >
> >
> >
> >
> > 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
> >>> documentation.
> >
> > 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.
>
> Ah, I see what the misunderstanding is.  Breaking lines at 79 chars is
> good.  How to break the lines is the only objection here.  In python,
> triple quotes start a multiline string.  So there's no need to have
> backslashes for continuation. You can just do this:
>
> """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.
> [...]
> """

thank you so much.
will work on it today,

thank you again.


> -Toshio
>
> _______________________________________________
> copr-devel mailing list
> copr-devel at lists.fedorahosted.org
> https://lists.fedorahosted.org/mailman/listinfo/copr-devel
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fedorahosted.org/pipermail/copr-devel/attachments/20130914/3dafcb86/attachment.html>


More information about the copr-devel mailing list