Fix missing line in man task-color #3665
Merged
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.
Escape leading single quote to prevent groff misinterpretation as a control character.
Issue
In
man 5 task-color
, the sentence cuts off unexpectedly:There is also 'color.project.none', 'color.tag.none' and
This occurs just before the
THEMES
section.Explanation
According to
man 7 groff
documentation, a leading single quote'
is interpreted as a control character and should be escaped as\[aq]
to render correctly.The
man 7 groff_char
page provides further details on character usage, and there has been long-standing discussion about this issue.As suggested in the
Getting Started
section ofman 1 groff
documentation, here’s a quick way of testing the escaped sequences output:For UTF-8:
Other options
Other approaches considered:
\'
escape sequence which renders as’
rather than'
\(aq
instead of\[aq]
— while shorter,\[aq]
clearly separates the escape sequence from the text, and documentation specifically recommends it