Generate a better OpenAPI description from docstring #462
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.
As this PR is a minor one, I'm skipping the issue creation. Please forgive me...
Context
If a docstring is well indented (often automatically by black or other) the generated description for OpenAPI will contains indentation, which is not desirable. Markdown will interpret this indentation as code block:
generates
with this PR, the generated MD would be
Have a nice day :)
Antoine