Update typing and documentation for responses parameter on doc decorator#467
Merged
greyli merged 3 commits intoapiflask:mainfrom Aug 13, 2023
tsokalski:fix-responses-typing
Merged
Update typing and documentation for responses parameter on doc decorator#467greyli merged 3 commits intoapiflask:mainfrom tsokalski:fix-responses-typing
responses parameter on doc decorator#467greyli merged 3 commits intoapiflask:mainfrom
tsokalski:fix-responses-typing
Conversation
…corator to match implementation.
greyli
approved these changes
Aug 13, 2023
Member
|
Merged, thanks! |
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
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.
Update the typing and documentation on the
responsesparameter of thedocdecorator to match the implementation changes introduced in version 2.0.0 via #458.Fixes #466.
I'm not sure why mypy isn't complaining about the type mismatch, but I think the parameter typing merits expansion after the 2.0.0 changes. I reworded the documentation a bit but I'm open to feedback or adjustments on it.
Checklist:
docsfolder and in code docstring.CHANGES.mdsummarizing the change and linking to the issue.*Version changed*or*Version added*note in any relevant docs and docstring.pytestandtox, no tests failed.