On Sunday 09 December 2001 17:45, Chuck Esterbrook wrote:
> On Sunday 09 December 2001 02:54 pm, Tavis Rudd wrote:
> > 1) require the first LINE (not parag.) to be a synopsis of the
> > method.
>
> Won't this violate the margin? eg, my first line descriptions will
> sometimes exceed column 79.
I
On Sunday 09 December 2001 02:54 pm, Tavis Rudd wrote:
> 1) require the first LINE (not parag.) to be a synopsis of the
> method.
Won't this violate the margin? eg, my first line descriptions will
sometimes exceed column 79.
Is there a special reason to break after the first sentence? I know
p
On Sun, Dec 09, 2001 at 02:54:22PM -0800, Tavis Rudd wrote:
> def foo(self):
> """
> Returns foo
>
> More detailed info ...
> """
There's also the three-more-spaces convention:
def foo(self):
"""First line...
Second line...
Third line.
Looks good. I like the 'first word is verb' bit and like how you
capitalize the synopsis.
Two things I'd change:
1) require the first LINE (not parag.) to be a synopsis of the method.
2) suggest, rather than require, that the """ be on a line by itself.
Emacs will automatically suck out the n
