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

custom comment at each method #36

Open
alexlopespereira opened this issue Sep 7, 2017 · 3 comments
Open

custom comment at each method #36

alexlopespereira opened this issue Sep 7, 2017 · 3 comments

Comments

@alexlopespereira
Copy link

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
Copy link
Contributor

jwg4 commented Sep 8, 2017

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

@korenerok
Copy link

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
Copy link

I've got the same problem as korenerok.

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

No branches or pull requests

4 participants