Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upformat :param the_param_name: description correctly #143
Comments
This comment has been minimized.
This comment has been minimized.
|
pdoc only supports Markdown. |
BurntSushi
closed this
Mar 9, 2018
This comment has been minimized.
This comment has been minimized.
|
Thanks for replying so fast. So is there a common way to format parameters in markdown or does anyone his own thing? |
This comment has been minimized.
This comment has been minimized.
|
Do your own thing. |
This comment has been minimized.
This comment has been minimized.
shayneoneill
commented
Jun 18, 2018
|
Is there any chance of getting this issue revisited. The :param name: desc type things are at the very least a defacto standard for docstrings, and the better ides can generate these automatically from function signatures, so having the ability to interpret these would be huge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
limchr commentedMar 9, 2018
Usually the parameters of a method or function is formatted like this in docstring:
:param the_param_name: description
pdoc is not converting this correctly. Is there a way to display parameters nicely?
Otherwise I really like it, thanks you for creating it!