Oh, and we should include the file in each project with a link to whatever the base one is.<div><br></div><div>That said, I don't intend to change the style of my project just because the common one changes, and it shouldn't be a wiki because that makes it too easy to change.<br>
<br><div class="gmail_quote">On Thu, Mar 22, 2012 at 3:01 PM, Andy Smith <span dir="ltr"><<a href="mailto:andyster@gmail.com">andyster@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br><br><div class="gmail_quote"><div class="im">On Thu, Mar 22, 2012 at 9:22 AM, Andrew Bogott <span dir="ltr"><<a href="mailto:abogott@wikimedia.org" target="_blank">abogott@wikimedia.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Just now I set out to merge a recent style guide change from python-novaclient into the hacking docs of other OpenStack projects. My patch didn't apply, though, because each project has subtly diverging HACKING files.<br>
<br>
Rather than contribute to this divergence, I've now read and compared the style guides from Nova, Glance, Keystone, python-keystoneclient, and python-novaclient. From these diffs I've created a file (attached) that encompasses the total of all guidelines from all projects. Remarkably, this merge produced only minor disagreements, described below under the heading FLAMEBAIT.<br>
<br>
I propose that this unified style guide be copied into each of the above projects, with a mandate to maintain consistency henceforth. Any objections?<br>
<br>
-Andrew<br>
<br>
<br>
FLAMEBAIT (docstring format):<br>
<br>
The only explicit contradiction I came across is regarding docstring formatting. Glance says this:<br>
<br>
**DO NOT** leave an extra newline before the closing triple-double-quote.<br>
<br>
Nova, this:<br>
<br>
A docstring ends with an empty line before the closing quotations.<br>
<br>
I propose that we just pick one or the other, or remove both prescriptions.<br></blockquote><div><br></div></div><div>I'm fine with moving forward to not having the trailing newline, it was for an emacs feature that has since become smarter (and who cares about emacs anyway). It is mentioned as the preferred way in PEP8, so it runs into some disagreements from time to time. Most of the code in the projects has been written with the older rule (yes on trailing newline) but I haven't been blocking new code from not using it.</div>
<div class="im">
<div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
FLAMEBAIT (filename):<br>
<br>
Some projects have a HACKING file, and some have a HACKING.rst file. Doesn't .rst generally indicate a REST API definition? I propose that the file be called HACKING.<br></blockquote><div><br></div></div><div>HACKING.rst makes github format it correctly, let's move everything to rst.</div>
<div class="im">
<div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
<br>_______________________________________________<br>
Mailing list: <a href="https://launchpad.net/~openstack" target="_blank">https://launchpad.net/~openstack</a><br>
Post to : <a href="mailto:openstack@lists.launchpad.net" target="_blank">openstack@lists.launchpad.net</a><br>
Unsubscribe : <a href="https://launchpad.net/~openstack" target="_blank">https://launchpad.net/~openstack</a><br>
More help : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
<br></blockquote></div></div><br>
</blockquote></div><br></div>