[openstack-dev] Hacking and PEP 257: Extra blank line at end of multi-line docstring
Ziad Sawalha
ziad.sawalha at rackspace.com
Wed Feb 26 14:39:58 UTC 2014
On Feb 25, 2014, at 5:18 PM, Kevin L. Mitchell <kevin.mitchell at rackspace.com> wrote:
> On Tue, 2014-02-25 at 00:56 +0000, Ziad Sawalha wrote:
>> Seeking some clarification on the OpenStack hacking guidelines for
>> multi-string docstrings.
>>
>>
>> Q: In OpenStack projects, is a blank line before the triple closing
>> quotes recommended (and therefore optional - this is what PEP-257
>> seems to suggest), required, or explicitly rejected (which could be
>> one way to interpret the hacking guidelines since they omit the blank
>> line).
>
>
> I lobbied to relax that restriction, because I happen to use Emacs, and
> know that that limitation no longer exists with Emacs.
Given the recommendation in PEP-257 is based solely on that, should
we explicitly recommend not including that extra space?
Should we add that rule to hacking?
> I submitted the
> change that eliminated that language from nova's HACKING at the time…
Thanks, Kevin - based on that I’ll resubmit my change without the blank line.
> --
> Kevin L. Mitchell <kevin.mitchell at rackspace.com>
> Rackspace
>
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
More information about the OpenStack-dev
mailing list