Skip to content

Update typing and documentation for responses parameter on doc decorator#467

Merged
greyli merged 3 commits intoapiflask:mainfrom
tsokalski:fix-responses-typing
Aug 13, 2023
Merged

Update typing and documentation for responses parameter on doc decorator#467
greyli merged 3 commits intoapiflask:mainfrom
tsokalski:fix-responses-typing

Conversation

@tsokalski
Copy link
Copy Markdown
Contributor

Update the typing and documentation on the responses parameter of the doc decorator 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:

  • Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
  • Add or update relevant docs, in the docs folder and in code docstring.
  • Add an entry in CHANGES.md summarizing the change and linking to the issue.
  • Add *Version changed* or *Version added* note in any relevant docs and docstring.
  • Run pytest and tox, no tests failed.

Copy link
Copy Markdown
Member

@greyli greyli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

@greyli greyli merged commit 85a39ba into apiflask:main Aug 13, 2023
@greyli
Copy link
Copy Markdown
Member

greyli commented Aug 13, 2023

Merged, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect typing and documentation for responses parameter in doc decorator

2 participants