From: Jae-Joon L. <lee...@gm...> - 2009-05-17 04:08:37
|
On Fri, May 15, 2009 at 10:02 PM, John Hunter <jd...@gm...> 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 |