Document semantic linefeeds in CONTRIBUTING.rst #500
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hynek
changed the title
adiroiban
approved these changes
Apr 27, 2023
| c. Document any user-facing changes in one of the ``/docs/`` files. | ||
| Please use `one sentence per line`_. |
There was a problem hiding this comment.
The URL is named "one sentence per line", but I think that the rule is "one sentence or clause per line".
Suggested change
| Please use `one sentence per line`_. | |
| Please use `semantic linefeeds`_. |
|
I think I'll leave it because while Clause is better, I think it's somewhat less ambiguous — thanks for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While reviewing #483, I've noticed we never mention that docs should be written one sentence per line.
This fixes it.