CLI vs. API function docs #324
Unanswered
transfluxus
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
There is a difference in how the CLI and python API render functions by default. For this function:
the CLI creates this formatted docs:
public_func
public function...
Arguments:
a
: some numberReturns:
double of a
but the python API example renders this:
public_func
public function...
:param a: some number
:return: double of a
?
which does not look so nice in markdown...
is there a paramter that I need to set for the renderer? I checked several but couldn't find anything.
thanks!
Beta Was this translation helpful? Give feedback.
All reactions