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

Add and document a good way to render parameter documentation #23

Open
adamtheturtle opened this issue Feb 1, 2021 · 1 comment
Open

Comments

@adamtheturtle
Copy link
Contributor

Thank you for this package 🙏

There are a few major ways to write Python docstrings, the default rST way:

:param path: The path of the file to wrap
:type path: str

/Users/adam/Desktop/Autobazel screenshot.png
and the Google way:

Args:
    path (str): The path of the file to wrap

The Google way is supported using sphinx.ext.napoleon.

The documentation in this package's examples is a mix of both, and not rendered nicely.
I have attached a screenshot of this package's documentation.
In particular, the word "Args" shows as inline in the docstring and the word "Param" is capitalised and rendered.

Autobazel screenshot

@adamtheturtle
Copy link
Contributor Author

As a workaround I'm using:

Args:
    :path: The path of the file to wrap

Note the extra : before path:.

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

1 participant