Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

better parsing of docstrings #33

Conversation

joranbeasley
Copy link
Contributor

I was frusterated by my IDE, which attempts to helpfully provide sphinx parameter definitions in any docstrings, which caused the openapi spec docs to look funny. i have been using a version with these changes for a while, and decided they might be useful to others

Im not sure if this is the appropriate place but this (or if it belongs more on annotation or something?)

ignores parameter specifications in docstrings

attempts to split the docstring into both a summary as well as a description.

I also would like to propose allowing example as an argument to field() (not in this merge request)
as it is a valid openapi specification for parameters

@joranbeasley
Copy link
Contributor Author

joranbeasley commented Feb 25, 2019

ps ... oof your test cases are were tough to pass :P (not really ... just had a ton of pep8 issues at first :P )

@Bogdanp Bogdanp closed this Apr 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants