Re: [dpdk-dev] [PATCH v1] doc: change doc line length limit in contributors guide

[Thomas Monjalon <thomas@monjalon.net>]

16/05/2017 16:20, Mcnamara, John:
> 
> > -----Original Message-----
> > From: Thomas Monjalon [mailto:thomas@monjalon.net]
> > Sent: Friday, May 12, 2017 10:24 AM
> > ,,,
> >
> > > The current DPDK "single sentence per line plus wrap at ~120 characters"
> > > guideline is unusual, not supported by editors and, with rare
> > > exceptions, not followed by anyone.
> > >
> > > As such I think the guidelines should reflect how people actually
> > > write docs and submit patches, which is wrapping at 80 characters.
> > 
> > I am OK with 80 characters.
> > However, I think we should keep trying to explain that it is better to
> > wrap at the end of a sentence.
> > 
> > Example:
> > This long sentence with a lot of words which does not mean anything will
> > wrap at 80 characters and continue on the second line. Then a new sentence
> > starts and ends on the third line.
> > 
> > It would be better like that:
> > This long sentence with a lot of words which does not mean anything will
> > wrap at 80 characters and continue on the second line.
> > Then a new sentence starts and ends on the third line.
> 
> This is essentially the same problem as the current guideline: that this
> is an artificial way of writing text, it isn't supported by editors,
> and is unlikely to be followed in practice.
> 
> The first example is the way people write text and the way text is submitted
> in patches so the guidelines should reflect this.

You are the doc maintainer, it's your call :)