You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/documentation/authors.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -354,9 +354,11 @@ The Plone Documentation Team adopted additional guidelines.
354
354
English semantic rules are difficult to understand and enforce.
355
355
356
356
Not following this guidance makes pull request reviews needlessly difficult, often resulting in noisy diffs.
357
+
357
358
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.
360
362
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.
361
363
362
364
Following this guidance will greatly improve the editing and maintenance of your documentation.
0 commit comments