📝 Add docstrings to testing module#1677
Open
mastash3ff wants to merge 1 commit intofastapi:masterfrom
Open
Conversation
Add a module docstring, class docstring for `CliRunner`, and a method docstring for `CliRunner.invoke` in `typer/testing.py`. All three were undocumented. Docstrings follow the existing project style (plain prose with Markdown and links to the relevant tutorial page).
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.pyshipped with no docstrings on the module, theCliRunnerclass, or itsinvokemethod. This PR adds all three.CliRunnerclass docstring — explains what it extends and why, with a short usage example that mirrors the style used for theTyperclass intyper/main.py.CliRunner.invokedocstring — describes what the method does and delegates to for readers who land on the API reference.No logic, behaviour, or type annotations were changed. The diff is +48 / -0 lines.
Checklist
ruff checkpassesruff format --checkpasses