DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH] doc/contributing: update RST text-wrapping guidelines
Date: Fri,  3 Nov 2023 13:29:10 +0000	[thread overview]
Message-ID: <20231103132910.88333-1-bruce.richardson@intel.com> (raw)

Update and clarify the guidelines on how to wrap lines in our RST docs.
We no longer limit lines to just 80 characters, and what is more
important that line length is the wrapping of sentences, starting a new
sentence on a new line, and wrapping at punctuation.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/contributing/documentation.rst | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 4eb62fc36a..9c90efb4ac 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -234,12 +234,18 @@ The most common guidelines for writing RST text are detailed in the
 The additional guidelines below reiterate or expand upon those guidelines.
 
 
-Line Length
-~~~~~~~~~~~
+Line Length and Wrapping
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-* 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.
+* Documentation lines should be less than 100 characters.
+
+* Each sentence should start on a new line.
+  Multiple sentences, which are not separated by a blank line,
+  are joined automatically into paragraphs.
+
+* Wrap sentences at punctuation points, for example, at a comma.
+  If no punctuation, put the newline at a logical point in the sentence,
+  for example, at the end of a clause before an "and" or "but".
 
 * Lines in literal blocks should be less than 80 characters
   since they are not wrapped by the document formatters.
-- 
2.39.2


             reply	other threads:[~2023-11-03 13:29 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-03 13:29 Bruce Richardson [this message]
2023-11-03 13:42 ` Ferruh Yigit
2023-11-06 11:33   ` Thomas Monjalon
2023-11-24 13:51 ` David Marchand

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231103132910.88333-1-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).