-
Notifications
You must be signed in to change notification settings - Fork 612
Add one sentence per line to the style guide #2470
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: devel
Are you sure you want to change the base?
Add one sentence per line to the style guide #2470
Conversation
Have you considered https://sembr.org instead? We try to use it for Packaging Guidelines and other docs in Fedora. |
Hey, thanks for mentioning sembr @gotmax23 I'm familiar with it. That set of conventions seems a bit too prescriptive. My feeling is that it's better to keep it simple and limited to more of a general guideline / best practice. I'm certainly open to sembr if other folks think it's worth going in that direction though. |
I agree that one sentence per line is already much bettre than the status quo. How about formulating it "at least one line per sentence"? That would allow folks to adhere to sembr already now. |
I like it. |
|
||
Use one sentence per line | ||
------------------------- | ||
Consider using a technique called *one sentence per line* when composing paragraphs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider using a technique called *one sentence per line* when composing paragraphs. | |
Consider using a technique called *one sentence per line* when composing paragraphs, or use at least one line per sentence (following https://sembr.org/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@oraNod ^^ might address the option to follow sembr.. accept or reject and then we can merge this puppy!
Fixes #2463