docs: fix CliRunner.invoke() docstring to reference 'app' parameter#1473
Open
Mohamed-Elwasila wants to merge 1 commit intofastapi:masterfrom
Open
docs: fix CliRunner.invoke() docstring to reference 'app' parameter#1473Mohamed-Elwasila wants to merge 1 commit intofastapi:masterfrom
Mohamed-Elwasila wants to merge 1 commit intofastapi:masterfrom
Conversation
The invoke() method in Typer's CliRunner accepts an 'app' parameter (Typer application) instead of 'cli' (Click command). Updated the docstring to accurately reflect this Typer-specific parameter and clarify that this is a wrapper around Click's CliRunner.
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.
What I Fixed
The
CliRunner.invoke()method had outdated documentation that referenced acliparameter, but the actual parameter is calledapp.Why This Matters
When developers use
CliRunnerfor testing, they see documentation mentioning a parameter that doesn't exist. This happens because Typer'sCliRunnerinherits the docstring from Click's version, which uses different parameter names.Now the docs correctly show that you pass in a
Typerapplication object via theappparameter.Changes Made
:param cli:to:param app:in the docstring