Skip to content

Commit c72e8aa

Browse files
committed
Add comment on "Semantic Linefeeds" to writers guide
Signed-off-by: Grant Likely <[email protected]>
1 parent 57089ca commit c72e8aa

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

writers-guide.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,32 @@ a flexible markup language with lots of options for laying out text. To keep
33
thinks simple, this file describes the conventions used by this project. As
44
much as possible, use these methods for markup.
55

6+
Source Text Style
7+
=================
8+
The reStructuredText marking is very human-friendly and readable as is,
9+
but most people will read the pdf or html output instead of the source files.
10+
To make changes to the content easier to find,
11+
use "semantic linefeeds" when writing as described by Brian Kernighan:
12+
13+
Hints for Preparing Documents
14+
15+
Most documents go through several versions (always more than you expected)
16+
before they are finally finished.
17+
Accordingly, you should do whatever possible to make the job of changing them easy.
18+
19+
First, when you do the purely mechanical operations of typing,
20+
type so subsequent editing will be easy.
21+
Start each sentence on a new line.
22+
Make lines short, and break lines at natural places,
23+
such as after commas and semicolons, rather than randomly.
24+
Since most people change documents by rewriting phrases and adding,
25+
deleting and rearranging sentences,
26+
these precautions simplify any editing you have to do later.
27+
28+
Brian W. Kernighan, 1974
29+
30+
Source : http://rhodesmill.org/brandon/2012/one-sentence-per-line/
31+
632
Tables
733
======
834
Use the simplified markup for tables as shown below. Use the tabularcolumns

0 commit comments

Comments
 (0)