Various minor formatting and wording fixes. Added missing description for set_oversampling #1268
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
acli
commented
May 27, 2024
acli
commented
- Added description for set_oversampling interactive command
- Various minor wording fixes
- Various minor formatting fixes
- Manual section title should be just “sfizz” (or left out)
- Description in name section should not be capped
- In synopsis section, constant parts should be bolded and variables should be in italics
- Added bold and italics for options in other sections as appropriate
… for set_oversampling
paulfd
approved these changes
Jul 20, 2024
| @@ -1,31 +1,34 @@ | |||
| .TH sfizz_jack 1 "@MAN_TODAY@" "@CMAKE_PROJECT_VERSION@" "sfizz_jack man page" | |||
| .TH sfizz_jack 1 "@MAN_TODAY@" "@CMAKE_PROJECT_VERSION@" "sfizz" | |||
There was a problem hiding this comment.
I'm clueless about man pages. This changes the title of the page?
There was a problem hiding this comment.
It changes the section title (the page title remains “sfizz_jack”). It used to say it belonged to the “sfizz_jack man page” section, which made little sense; the patch changes it to say it belongs to the “sfizz” section.
| .SH SYNOPSIS | ||
| sfizz_jack [FILE] [OPTIONS...] | ||
| .B sfizz_jack | ||
| [\fIFILE\fR] [\fIOPTIONS\fR...] |
There was a problem hiding this comment.
\fI is "start italic" and \fR is "start regular"?
There was a problem hiding this comment.
Yes. Instead of \fR I believe we can also say \fP (previous font, probably; I’ll need to dig out the manual to be sure), which undoes the most recent font change.
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.