Add docstrings to CliRunner and internal model classes#1671
Closed
mastash3ff wants to merge 1 commit intofastapi:masterfrom
Closed
Add docstrings to CliRunner and internal model classes#1671mastash3ff wants to merge 1 commit intofastapi:masterfrom
mastash3ff wants to merge 1 commit intofastapi:masterfrom
Conversation
Add class and method docstrings to the testing.CliRunner and CliRunner.invoke, which are part of the public testing API but were previously undocumented. Also add class-level docstrings to the internal model classes in models.py: CommandInfo, TyperInfo, ParameterInfo, OptionInfo, ArgumentInfo, ParamMeta, and DeveloperExceptionConfig.
Author
|
Closing — this PR was opened by an automated contribution agent that has been disabled. Apologies for the noise. |
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.
Summary
typer.testing.CliRunnerandCliRunner.invoke, which are part of the public testing API but were previously undocumented. Includes a usage example and parameter descriptions.models.py:CommandInfo,TyperInfo,ParameterInfo,OptionInfo,ArgumentInfo,ParamMeta, andDeveloperExceptionConfig.No logic, behavior, or test changes. Docstring style matches the existing conventions in the codebase (Markdown formatting with example blocks).
Test plan
ruff checkpasses on both changed filesruff format --checkconfirms no formatting issuesmypypasses on both changed files