Skip to content

Commit b90ff43

Browse files
authored
Merge pull request #43279 from tengqm/wrap-line-style
Amend the style guide for line wrapping
2 parents 3d97727 + 80e6a83 commit b90ff43

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

content/en/docs/contribute/style/style-guide.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -457,6 +457,15 @@ be two newlines. Second-level headings follow the first-level (or the title) wit
457457
any preceding paragraphs or texts. A two line spacing helps visualize the overall
458458
structure of content in a code editor better.
459459

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+
460469
### Headings and titles {#headings}
461470

462471
People accessing this documentation may use a screen reader or other assistive technology (AT).

0 commit comments

Comments
 (0)