On Wed, Dec 29, 2004 at 10:47:58AM +0100, Juerd wrote: > > NAME - contains the module or script name, a dash and a short > > description (the abstract). > > How short? One line or sentence? One paragraph? > > I don't think any rules for this exist. I try to keep it within one > line. > > Does anyone know about written or unwritten rules about the length of an > abstract? > > Hm, I note that MakeMaker uses /^($package\s-\s)(.*)/ on a line read > with $/ being "\n". This means it has to be one line, right? Should MM > be changed, or should pod documents document that the NAME paragraph > should be one line? If the latter, do we have opinions about the length > of a line?
The "Module::Name - One line module description" has been pretty standard stuff for a long time. No, MakeMaker's stuff shouldn't be changed at this point, its a simple convention so we can pull an abstract out of POD. The line length should be 76 (ie. 80 minus a little bit to take into account any indentation applied by formatters). It looks horrid when it wraps. -- Michael G Schwern [EMAIL PROTECTED] http://www.pobox.com/~schwern/ Fuck with me and I will saw off your legs. http://www.unamerican.com/
