[CLI] Fix parent aliases leaking into subcommand headers in CLI reference#4253
Merged
Conversation
…ence Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Contributor
|
This PR has been shipped as part of the v1.17.0 release. |
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
2 participants
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.
Fixes titles in current docs:
repos | repo,extensions | ext) were leaking into subcommand section headers in the generated CLI reference. For instance#### hf repos | repo branch createinstead of#### hf repos branch create._transform_sectioningenerate_cli_reference.pyto strip aliases from all path segments, and only annotate the description when the leaf command itself has aliases (e.g.list | ls).Before:
### hf repos | repo branch create,### hf extensions | ext installAfter:
### hf repos branch create,### hf extensions install🤖 Generated with Claude Code
Note
Low Risk
Low risk documentation-generation change: adjusts regex parsing for CLI reference headers and updates the generated
cli.mdplus a unit test, with no runtime CLI behavior impact.Overview
Fixes CLI reference generation so parent group aliases (e.g.
repos | repo,extensions | ext) no longer leak into subcommand section headers.Updates
_normalize_command_aliasesinutils/generate_cli_reference.pyto strip aliases from every command-path segment and only append alias info for the leaf command, then regeneratesdocs/source/en/package_reference/cli.mdaccordingly and updates the related test expectation.Reviewed by Cursor Bugbot for commit 1f5f46a. Bugbot is set up for automated code reviews on this repo. Configure here.