[IPython-dev] Release plan for 0.9

Fernando Perez fperez.net@gmail....
Mon Aug 11 20:38:06 CDT 2008


On Sat, Aug 9, 2008 at 12:34 AM, Ville M. Vainio <vivainio@gmail.com> wrote:
> On Fri, Aug 8, 2008 at 11:08 PM, Fernando Perez <fperez.net@gmail.com> wrote:
>
>> Great, thanks.  I'll have a look then.  Ville, do you have any other
>> specific comments or concerns here, or should I proceed with the merge
>> right away?
>
> No specific comments, so merge ahead.

Mmh, I was getting ready to merge and push, but then I went and looked
at the code, and I see the whole thing is written in camelCase():

http://bazaar.launchpad.net/%7Evivian-vdesmedt/ipython/synchronize-editor/annotate/1007?file_id=ipy_synchronize_with-20080612032938-lxufpyi2plzu3mlc-1

Why is that the case?  For all new code, we are really trying to stick
to proper PEP-8 within reason, and I don't want to violate that unless
there's a good motive for it.

I also don't see any docstrings in any of the functions at all.

Vivian, I realize that this may be a bit painful, but as you can see,
we're now making an honest effort at building a much higher quality
codebase for IPython, so that all code that goes in is reviewed,
documented and tested.  And we are all living by the same rules (see
recent reviews on other branches, and all the work that has gone into
having testing machinery for ipython itself).

With bzr and launchpad, it's relatively easy for you to track the
trunk (simply keep merging from trunk into your working branch and
pushing back upstream frequently), so that your branch stays up to
date, as you improve it.  But I really think that we can't merge this
code in until it's properly documented and it matches the naming
conventions of the rest of the project.

I realize it's a bit frustrating at this point, but hopefully it's
clear to you that these rules are there to ensure that as the whole
project grows in a very healthy fashion.  We're getting more new code
coming in than any one of us can handle individually, and the only way
we won't crumble under the weight is to enforce that all this new code
is compliant with the rest of the project, documented and
automatically tested.

Regards,

f

ps - I've added the above as a branch review comment on launchpad as well.


More information about the IPython-dev mailing list