Skip to content

Commit 0642955

Browse files
authored
Amend docs for multi-line suggestions (#1866)
1 parent d59d606 commit 0642955

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/contributing/documentation/authors.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,9 +354,11 @@ The Plone Documentation Team adopted additional guidelines.
354354
English semantic rules are difficult to understand and enforce.
355355

356356
Not following this guidance makes pull request reviews needlessly difficult, often resulting in noisy diffs.
357+
357358
The reviewer can't give targeted feedback for a single sentence when there are multiple sentences on one line.
358-
When a single sentence is broken across multiple lines, the reviewer has to submit one suggestion per line.
359-
Most reviewers won't do that, and instead make a comment instead of a suggestion.
359+
360+
When a single sentence is broken across multiple lines, the reviewer may not know that they can submit [one suggestion for multiple lines](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-comments-to-a-pull-request).
361+
Instead, they either make a comment or a single suggestion leaving the author to manually edit the lines.
360362
This in turn deprives you of the easy option to commit the suggestion to the pull request by a single click of a button in the GitHub user interface.
361363

362364
Following this guidance will greatly improve the editing and maintenance of your documentation.

0 commit comments

Comments
 (0)