Enhance Plone documentation style guide #1864
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
- Clarify why we use one sentence per line - Add links to Microsoft Style Guide for verb tense, usage, and examples. - Add `.vscode/settings.json` reference and example file.
davisagli
approved these changes
Feb 16, 2025
|
In addition to the reasons against semantic line breaks already stated in this PR, they are a barrier to contributors who are not fluent in English. How would you teach it to volunteer contributors without scaring them away? So between that, PEP8, and avoiding horizontal scrolling during diff reviews, the one sentence per line pattern is a reasonable compromise for our international audience. Thanks for the link for the multiple line suggestion. TIL. I'll amend the docs. It would be good to point people to that. Almost all of the suggestions I see are single-line. |
This was referenced Feb 17, 2025
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.
.vscode/settings.jsonreference and example file.📚 Documentation preview 📚: https://plone6--1864.org.readthedocs.build/