-
-
Notifications
You must be signed in to change notification settings - Fork 773
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docstring of connexion.ConnexionMiddleware.add_api
#2030
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR modifies a function that returns no value, to add :return:
line to the function's Pydoc block. This just looks wrong to me. Please explain.
Actually this PR only updates the docstring of the function, and not the function itself. The function still returns nothing, but the docstring said that it actually returned something, which can be confusing (and I can confirm because I got confused by it 😅) |
You're right, I misread your PR, thanks for clarifying. +1 from me! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank for the PR! Although we can just delete the return documentation entirely
Pipeline fails due to some unrelated issue (for some reason, mypy is checking some files in a transitive dependency that got recently added) |
Changes proposed in this pull request:
connexion.ConnexionMiddleware.add_api
to match return value to actual return.