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

format :param the_param_name: description correctly #143

Closed
limchr opened this issue Mar 9, 2018 · 4 comments
Closed

format :param the_param_name: description correctly #143

limchr opened this issue Mar 9, 2018 · 4 comments

Comments

@limchr
Copy link

limchr commented Mar 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!

@BurntSushi
Copy link
Contributor

pdoc only supports Markdown.

@limchr
Copy link
Author

limchr commented Mar 9, 2018

Thanks for replying so fast. So is there a common way to format parameters in markdown or does anyone his own thing?

@BurntSushi
Copy link
Contributor

Do your own thing.

@shayneoneill
Copy link

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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants