Improve the docstrings
Open
doc
good first issue
- Dominant language
- Python
- Stars
- 521
- Forks
- 86
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 35
Description
I'd like the docstrings of the public API methods and functions of Param to be improved which should improve:
* the API reference page of the website
* the user experience in a code editor
I'm opening this issue to report (later) ideas and findings. For now I would just like to note that Param doesn't seem to follow [PEP257](https://www.python.org/dev/peps/pep-0257/) and also doesn't follow any format (presumably because Param predates the creation of these formats) such as Numpydoc, Google... I quite like [Google's style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) which is less verbose than Numpy's one.
Contributor guide
Assessment
This issue has not been assessed yet.