From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Mcnamara, John" Subject: Re: [PATCH v1] doc: change doc line length limit in contributors guide Date: Fri, 12 May 2017 09:10:49 +0000 Message-ID: References: <1494511780-5732-1-git-send-email-john.mcnamara@intel.com> <6951954.sJVyEfo4GT@xps> <3737023.yBcUv04Hz8@xps> <8CEF83825BEC744B83065625E567D7C224D5D178@IRSMSX108.ger.corp.intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Cc: "dev@dpdk.org" To: "Iremonger, Bernard" , Thomas Monjalon Return-path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id AB4AB106A for ; Fri, 12 May 2017 11:11:14 +0200 (CEST) In-Reply-To: <8CEF83825BEC744B83065625E567D7C224D5D178@IRSMSX108.ger.corp.intel.com> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: Iremonger, Bernard > Sent: Thursday, May 11, 2017 6:31 PM > To: Thomas Monjalon ; Mcnamara, John > > Cc: dev@dpdk.org > Subject: RE: [dpdk-dev] [PATCH v1] doc: change doc line length limit in > contributors guide >=20 >=20 > > -----Original Message----- > > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon > > Sent: Thursday, May 11, 2017 6:18 PM > > To: Mcnamara, John > > Cc: dev@dpdk.org > > Subject: Re: [dpdk-dev] [PATCH v1] doc: change doc line length limit > > in contributors guide > > > > 11/05/2017 18:11, Mcnamara, John: > > > From: Thomas Monjalon [mailto:thomas@monjalon.net] > > > > > > > > ... > > > > > -* The recommended style for the DPDK documentation is to put > > > > > sentences > > > > on separate lines. > > > > > - This allows for easier reviewing of patches. > > > > > - Multiple sentences which are not separated by a blank line > > > > > are joined > > > > automatically into paragraphs, for example:: > > > > > +* Lines in sentences should be less than 80 characters and > > > > > +wrapped at > > > > > + words. Multiple sentences which are not separated by a blank > > > > > +line are joined > > > > > + automatically into paragraphs. > > > > > > > > Why not keep the recommendation of separating sentences? > > > > > > This isn't a recommendation. It is just pointing out that lines and > > > sentences are joined into paragraphs. Maybe that is obvious and > > > doesn't need to be stated. > > > > I'm talking about "The recommended style for the DPDK documentation is > > to put sentences on separate lines." > > I like this recommendation. >=20 > +1 for this recommendation >=20 The problem is that almost no-one follows this recommendation. An 80 character margin is a simple rule that most programming editors can enforce or handle automatically. It is also what is recommended in OpenStack: https://docs.openstack.org/contributor-guide/rst-conv/general-guideline= s.html#lines-length The kernel doc guidelines don't have a length rule but their docs are wrapped at 80: https://www.kernel.org/doc/html/latest/_sources/doc-guide/sphinx.rst.tx= t The current DPDK "single sentence per line plus wrap at ~120 characters" guideline is unusual, not supported by editors and, with rare exceptions, n= ot 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. John