On Fri, May 15, 2009 at 10:02 PM, John Hunter <jdh2...@gmail.com> wrote: > When you are extending/fixing existing code and come across methods > with no docs, could you write a one or two line doc string for them? > I wrote many of these and at the time they were so obvious that they > didn't need docstrings, but as time passes and I reencounter them, I > wish there was a simple line explaining them. As you are digging > through the code figuring them all out, it is a great time to drop in > a simple one-liner docstring (eg explaining what coord system is being > returned by _get_position_xy). As the famous coding quip says, the > literal wording or author of which I cannot dig up right now, "Leave > comments in your code -- someone may read it someday, and that someone > may be you!"
Sure, I'll keep that in mind. I'll revise the patch (I'll also think about the contains method) and submit it soon. Thanks, -JJ ------------------------------------------------------------------------------ Crystal Reports - New Free Runtime and 30 Day Trial Check out the new simplified licensing option that enables unlimited royalty-free distribution of the report engine for externally facing server and web deployment. http://p.sf.net/sfu/businessobjects _______________________________________________ Matplotlib-users mailing list Matplotlib-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/matplotlib-users
