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 thought that at first, but in most cases I've been able to keep it under that. But come to think about it, a wrapped sentence followed by a blank line would be ok as well. The convention is to allow documentation tools to extract a single sentence synopsis. All they have to do is search for a blank line. > Is there a special reason to break after the first sentence? I know > pydoc will treat the first sentence/paragraph/whatever of a class > doc string special, but does this apply to methods as well? Pydoc doesn't use this yet, but future tools coming out of doc-sig will. > Well, at least we agree on most things for change. :-) :) > I played with Alt-q in emacs. is that an emacs thing a python mode > binding thing? I'm wondering if we can get it to break on """ as > well newlines.... I'm not sure. Alt-q is global to emacs, but it might be overriden in python mode. I don't think it's worth hacking with though. There's more important things to do. _______________________________________________ Webware-devel mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/webware-devel
