incubator-cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joe Brockmeier <...@zonker.net>
Subject Re: [DOCS][DISCUSS] Some style / formatting issues in docs
Date Thu, 18 Oct 2012 15:03:46 GMT
On Thu, Oct 18, 2012 at 10:51:15AM -0400, David Nalley wrote:
> > I'd also like to discuss the formatting / wrapping of the files
> > themselves. The release notes are hard-wrapped right now so that there
> > are line breaks at about 80-100 columns even if it means something like
> > this:
> >
> > <note>
> >     <para>I've got some text here
> >     and it wraps oddly.</para>
> > </note>
> >
> That said, our Java coding standards says lines shouldn't be more than
> 80 chars:
> http://docs.cloudstack.org/CloudStack_Documentation/Design_Documents/Coding_Conventions#Files.2C_Layout_and_whitespace

Sure, but this isn't Java. If you look at, for instance, the upstream
Publican docs:

http://git.fedorahosted.org/cgit/publican.git/tree/publican/Users_Guide/en-US

> That said, I am not necessarily married to this, but line lengths that
> hit 500-600 characters is undesirable in my mind.

Not sure that any arbitrary wrapping length is desirable, though.
Where's the cut-off?

Best, 

Joe
-- 
Joe Brockmeier
Twitter: @jzb
http://dissociatedpress.net/

Mime
View raw message