Strip argument documentation from command help text.#4451
Merged
Qalthos merged 1 commit intoansible:mainfrom May 30, 2025
Merged
Strip argument documentation from command help text.#4451Qalthos merged 1 commit intoansible:mainfrom
Qalthos merged 1 commit intoansible:mainfrom
Conversation
Click stops processing docstrings when it encounters a formfeed (\f) character. We can use this to keep the method argument documentation out of the command help syntax.
cidrblock
approved these changes
May 30, 2025
github-project-automation
bot
moved this from Review
to Done
in 🧰 devtools project board
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.
Click stops processing docstrings when it encounters a formfeed (\f) character. We can use this to keep the method argument documentation out of the command help syntax.
See https://click.palletsprojects.com/en/stable/documentation/#truncating-help-texts