🐛 fix(prog): propagate :prog: override to subcommands#288
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Mar 2, 2026
Merged
🐛 fix(prog): propagate :prog: override to subcommands#288gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat merged 1 commit intotox-dev:mainfrom
Conversation
c91ab36 to
bedd7e6
Compare
When using the :prog: directive option to rename the program, only the top-level parser prog was updated. Subcommand parsers still retained the original prog, producing inconsistent titles and references. Recursively updates all subparser prog values when :prog: is set. Fixes tox-dev#71
bedd7e6 to
e470565
Compare
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.
When using the
:prog:directive option to rename the program, only the top-level parser'sprogwas updated. Subcommand parsers still retained the original prog value, producing inconsistent section titles and cross-references in the generated documentation.The fix recursively walks all subparser trees via
_update_sub_parser_progand replaces the old prog prefix with the new one. This ensures that titles likemy-tool fooappear correctly instead oforiginal-name foo.Fixes #71