Fix: Don't truncate command docstrings in typer docs output#1494
Open
timonrieger wants to merge 1 commit intofastapi:masterfrom
Open
Fix: Don't truncate command docstrings in typer docs output#1494timonrieger wants to merge 1 commit intofastapi:masterfrom
typer docs output#1494timonrieger wants to merge 1 commit intofastapi:masterfrom
Conversation
…nd_obj.help` instead of `get_short_help_str()`
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 docstring truncation when generating documentation with
typer docs.Changed
get_short_help_str()tocommand_obj.helpin the commands list generation to display full docstrings instead of truncated versions, matching the behavior used for the main command help text.