mkautodoc icon indicating copy to clipboard operation
mkautodoc copied to clipboard

Published 20 hours ago • verified publisher icon tomchristie

Docstring format supported ?

Open jlegrand62 opened this issue 4 years ago • 2 comments

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!

jlegrand62 avatar Sep 18 '20 15:09 jlegrand62

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

phihung avatar Oct 25 '20 00:10 phihung

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

woile avatar Apr 06 '21 08:04 woile