Styling project command line options#12146
Open
philderbeast wants to merge 22 commits into
Open
Conversation
Collaborator
|
I like the change, but 80 new lines of Python, I don't fancy those. |
philderbeast
force-pushed
the
doc/project-option-command-line-variants
branch
from
July 22, 2026 21:29
9111196 to
5a478c3
Compare
philderbeast
force-pushed
the
doc/project-option-command-line-variants
branch
from
July 22, 2026 21:30
5a478c3 to
344b863
Compare
- reject-unconstrained* was not indented at 4 spaces
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
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.
Related to #12144, renders the project command line options with a command line style. The
--preceded options are parsed out or you can optionally use a:command-line-options:directive.Note
If this is acceptable and enough to show command line options (the
$prefix indicating this), then we might remove some of the text describing the same thing. In other words, instead of fixing #12144 by using the plural, we could remove a lot of that text where it adds no value.Warning
I used Copilot to write the
*.pyand*.csschanges.I used sphinx warnings reporting missing references to identify undocumented command line options. I've added these as a new "Undocumented options" section, a fraction of which is shown here:
Having an undocumented section like this gets rid of those missing reference warnings. Also note the
enable-*, disable-*items on the same line. This works for linking to references.