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

Docstring format supported ? #27

Open
jlegrand62 opened this issue Sep 18, 2020 · 2 comments
Open

Docstring format supported ? #27

jlegrand62 opened this issue Sep 18, 2020 · 2 comments

Comments

@jlegrand62
Copy link

Hello,

Your project seems interesting but I don't see any reference to the style of Python docstring you can use like NumPy or Google...
Did I miss something?

Thanks!

@phihung
Copy link

phihung commented Oct 25, 2020

I don't know which style is this, but mkautodoc is used in the following package
https://www.python-httpx.org/api/
Here is what its docstring looks like
https://github.com/encode/httpx/blob/1bc3b0188a65cfa3f3dc8b85a0ed0e78d437ba5e/httpx/_api.py#L44

@woile
Copy link

woile commented Apr 6, 2021

I think the format is just markdown, you can write any markdown by the looks of it.

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

3 participants