Update the import statements for the cookbook snippets #1805
Conversation
This file contains 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
MatthiasDurivet
commented
Nov 10, 2023
|
|
||
| from asgi_framework import App | ||
| from connexion import ConnexionMiddleware | ||
| from connexion.lifecycle import ConnexionRequest, ConnexionResponse |
There was a problem hiding this comment.
Unless there's a hidden reason to import these classes (?) they were not used in the snippet.
There was a problem hiding this comment.
Thanks @MatthiasDurivet
There needs to be an empty newline at the start of each code block though. You can see that the rendering fails in the test build.
Locally, you can test this by running make html from the /docs directory.
RobbeSneyders
approved these changes
Nov 19, 2023
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.
Updates the import statements on https://connexion.readthedocs.io/en/stable/cookbook.html
A few of the import statements were missing, or didn't match the example code because they imported at the wrong depth.
This should make the code in the cookbook copy-pasteable.