search

acoomans / flask-autodoc

Flask autodoc automatically creates an online documentation for your flask application.
MIT License
98 stars 49 forks source link

custom comment at each method #36

Open alexlopespereira opened 7 years ago

alexlopespereira commented 7 years ago

I would like to be able to add a custom comment on each API function descriptions that appears in the report. Is it already possible? Would you develop that?

Thanks

jwg4 commented 7 years ago

No problem, just add a docstring to the function which services the endpoint. It will appear in the documentation as 'Description'.

korenerok commented 7 years ago

Hello, I have a question about the custom comment also: is there a way to insert special characters, such as new line, single or double quotes character in the description? I tried with to make a multiline docstring, and the result description has always one line... I tried to follow the convention of multiline docstring given here: https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings

Thanks in advance

kjohnsen commented 6 years ago

I've got the same problem as korenerok.