Skip to content
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

Merged
merged 3 commits into from
Feb 1, 2025

Conversation

bastantoine
Copy link
Contributor

Changes proposed in this pull request:

  • Update docstring of connexion.ConnexionMiddleware.add_api to match return value to actual return.

Copy link
Contributor

@chrisinmtown chrisinmtown left a 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.

@bastantoine
Copy link
Contributor Author

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 😅)

@chrisinmtown
Copy link
Contributor

You're right, I misread your PR, thanks for clarifying. +1 from me!

Copy link
Member

@Ruwann Ruwann left a 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

connexion/middleware/main.py Outdated Show resolved Hide resolved
connexion/middleware/main.py Outdated Show resolved Hide resolved
@Ruwann
Copy link
Member

Ruwann commented Feb 1, 2025

Pipeline fails due to some unrelated issue (for some reason, mypy is checking some files in a transitive dependency that got recently added)

@Ruwann Ruwann merged commit 1d4bb81 into spec-first:main Feb 1, 2025
5 of 7 checks passed
@bastantoine bastantoine deleted the patch-1 branch February 4, 2025 09:01
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.

3 participants