eclass-writing: Specify @BLURB more precisely #365
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
sbraz
suggested changes
Jan 5, 2025
eclass-writing/text.xml
Outdated
| Contains a short description for the eclass. Must be on the same | ||
| line with the tag. | ||
| Contains a short description for the eclass. Must be on the same line | ||
| with the tag. All words, including the first, must be in lowercase, except |
There was a problem hiding this comment.
Suggested change
| with the tag. All words, including the first, must be in lowercase, except | |
| as the tag. All words, including the first, must be in lowercase, except |
There was a problem hiding this comment.
Well, that was part of the existing text. 😄 Updated.
There was a problem hiding this comment.
Yeah I know :D But it did sound weird to me. I can't say for sure that the previous wording was wrong but I'm pretty confident the new one is not worse :)
The @blurb description appears in the NAME section of the generated man page, and should therefore follow the rules from man-pages(7): "All words in this line (including the word immediately following the '\-') should be in lowercase, except where English or technical terminological convention dictates otherwise." Since it is a section heading, it should not end with a full stop either. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
orlitzky
approved these changes
Jan 5, 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.
The
@BLURBdescription appears in theNAMEsection of the generated man page, and should therefore follow the rules from man-pages(7):"All words in this line (including the word immediately following the '\-') should be in lowercase, except where English or technical terminological convention dictates otherwise."
Since it is a section heading, it should not end with a full stop either.