> -----Original Message----- > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Bruce Richardson > Sent: Friday, July 3, 2015 10:54 AM > To: Thomas Monjalon > Cc: dev at dpdk.org > Subject: Re: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk > documentation > > On Thu, Jul 02, 2015 at 06:20:39PM +0200, Thomas Monjalon wrote: > > 2015-07-02 14:50, John McNamara: > > > +* Use one sentence per line in a paragraph, i.e., put a newline > > > +character > > > + after each period/full stop. > > > > What about adding this? > > Only blank line will generate a newline. > > > > I think breaking lines at end of sentence is more important than > > wrapping at 80 char, because it will help to keep patches readable. > > > +1 to this. I believe that one sentence per line should be the default > +wrapping > policy and only wrap if lines are very, very long. The why I like this > approach is > that changes tend to be sentence-based, and so having a sentence per line > makes for much cleaner diffs when updating - thereby making review easier. > > /Bruce
Hi Bruce, I think "very, very long" should be defined. When I was working on the rst files previously I wrapped sentences which were greater than 130 characters. I wrapped long sentences at punctuation points where possible, rather than at the character limit. Regards, Bernard.
