docs: fix invalid \fi font escape in man page (should be \fI)#903
Open
greymoth-jp wants to merge 1 commit into
Open
docs: fix invalid \fi font escape in man page (should be \fI)#903greymoth-jp wants to merge 1 commit into
\fi font escape in man page (should be \fI)#903greymoth-jp wants to merge 1 commit into
Conversation
Two occurrences of \`\fi\` (lines 312/314, --command-name option) are not valid nroff/troff escape sequences; italic is \`\fI\` (uppercase I). All other italic spans in the file correctly use \`\fI\`. Fix both. Also correct \`\-\-time-unit\` in the SYNOPSIS (line 38) to \`\-\-time\-unit\` for consistency with every other hyphenated long option in that block (e.g. \`\-\-min\-runs\`, \`\-\-max\-runs\`).
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Two typos in
doc/hyperfine.1:\fi→\fI(lines 312, 314) —\fiis not a valid nroff/troff font escape. Italic is\fI(uppercaseI). Every other italic span in the file already uses\fI(\fINUM\fP,\fIFILE\fP,\fIUNIT\fP, …). The two\fiNAME\fPoccurrences in the--command-nameoption description would render as literal text instead of an italic word.--time-unit→--time\-unitin SYNOPSIS (line 38) — minor consistency fix. Every other hyphenated long option in the SYNOPSIS block escapes its internal hyphens (\-\-min\-runs,\-\-max\-runs,\-\-parameter\-scan, etc.).\-\-time-unithad an unescaped second hyphen.Diff
No functional or behavioural change — documentation only.