You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
Thank you for this package 🙏
There are a few major ways to write Python docstrings, the default rST way:
/Users/adam/Desktop/Autobazel screenshot.png
and the Google way:
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.
The text was updated successfully, but these errors were encountered: