Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)

On Sunday 20 August 2006 04:39 am, Eric Hodel wrote:
> On Aug 19, 2006, at 5:46 PM, Eric Hodel wrote:
> > * Documentation wrapped to 80 characters

Sorry, I missed the original post that included that (and hope I have the 
attribution right), but want to comment (or question) now.


I'm assuming that the guideline cited above is aimed at (possibly among other 
things), aimed at (i.e., against) documentation that requires horizontal 
scrolling to view the full length of a line?  

While I am fiercely against  documentation that requires such horizontal 
scrolling, I'm not sure that is the best way to achieve that objective.

In general, I much prefer when documentation is not "hard wrapped" (with 
embedded \n (or similar) characters) but is free to be "soft wrapped" by the 
displaying application (and thus be wrapped (dynamically) to the width of the 
current viewing window).

(I may be totally off-base here--if this is for documentation intended to be 
embedded in the code as comments or similar, maybe that guideline (or a 
similar one, for a (somewhat/slightly) shorter line is appropriate.)

If my comment is totally off-base, sorry for the waste of bandwidth.

Randy Kramer