doc/contributing: update RST text-wrapping guidelines
PATCH 1/1 doc/contributing: update RST text-wrapping guidelines
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.
--- doc/guides/contributing/documentation.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-)
doc/guides/contributing/documentation.rst +11 -5
@@ -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.
Signature · 1 line
2.39.2
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Thomas Monjalon
Acked-by03/11/2023 14:42, Ferruh Yigit:
Quoted 9 lines · Bruce Richardson
Quoted 6 lines
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 <[email protected]>Acked-by Ferruh Yigit <[email protected]>
I'm doing a lot of such minor improvement when merging patches. I believe it makes doc more confortable to read and update.
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Applied, thanks.
Signature · 1 line
David Marchand