[PATCH] more consistent style

Eygene Ryabinkin rea at codelabs.ru
Mon Jan 12 00:21:48 UTC 2015


Mon, Jan 05, 2015 at 01:31:53PM +0100, Nicolas Sebrecht wrote:
> -        """
> -        Same as config.get, but returns the value of `default`
> -        if there is no such option specified.
> -        
> -        """
> +        """Same as config.get, but returns the value of `default`
> +        if there is no such option specified."""

Should probably be
{{{
        """config.get with defaults.

        Same as config.get, but returns the value of `default`
        if there is no such option specified.
        """
}}}
since PEP8 says that it's the way to go,
  https://www.python.org/dev/peps/pep-0008/#documentation-strings


My personal preference is
{{{
        """
        config.get with defaults.

        Same as config.get, but returns the value of `default`
        if there is no such option specified.

        """
}}}
since it is more readable to my eyes, but I can live with PEP8's way
of doing that.

Any views on this?
-- 
rea



More information about the OfflineIMAP-project mailing list