File tree Expand file tree Collapse file tree 1 file changed +9
-0
lines changed
content/en/docs/contribute/style Expand file tree Collapse file tree 1 file changed +9
-0
lines changed Original file line number Diff line number Diff line change @@ -457,6 +457,15 @@ be two newlines. Second-level headings follow the first-level (or the title) wit
457
457
any preceding paragraphs or texts. A two line spacing helps visualize the overall
458
458
structure of content in a code editor better.
459
459
460
+ Manually wrap paragraphs in the Markdown source when appropriate. Since the git
461
+ tool and the GitHub website generate file diffs on a line-by-line basis,
462
+ manually wrapping long lines helps the reviewers to easily find out the changes
463
+ made in a PR and provide feedback. It also helps the downstream localization
464
+ teams where people track the upstream changes on a per-line basis. Line
465
+ wrapping can happen at the end of a sentence or a punctuation character, for
466
+ example. One exception to this is that a Markdown link or a shortcode is
467
+ expected to be in a single line.
468
+
460
469
### Headings and titles {#headings}
461
470
462
471
People accessing this documentation may use a screen reader or other assistive technology (AT).
You can’t perform that action at this time.
0 commit comments