-
Notifications
You must be signed in to change notification settings - Fork 23
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
update docstrings #86
Comments
Should we use the default doc string format from Sphinx?
/home/s3bc40/mox-cu/moccasin/moccasin/config.py:docstring of moccasin.config.Config.dependencies:1: WARNING: duplicate object description of moccasin.config.Config.dependencies, other instance in api_reference/config_reference, use :no-index: for one of them
/home/s3bc40/mox-cu/moccasin/moccasin/config.py:docstring of moccasin.config.Config.extra_data:1: WARNING: duplicate object description of moccasin.config.Config.extra_data, other instance in api_reference/config_reference, use :no-index: for one of them
/home/s3bc40/mox-cu/moccasin/moccasin/config.py:docstring of moccasin.config.Config.networks:1: WARNING: duplicate object description of moccasin.config.Config.networks, other instance in api_reference/config_reference, use :no-index: for one of them
/home/s3bc40/mox-cu/moccasin/moccasin/config.py:docstring of moccasin.config.Config.project:1: WARNING: duplicate object description of moccasin.config.Config.project, other instance in api_reference/config_reference, use :no-index: for one of them
None:11: ERROR: Unexpected indentation. [docutils]
Also making a list in case people wants to contribute to avoid duplicate:
Do I have to create a dedicated branch to this issue from my fork repo, and group all other doc branch before going into main? |
We use a lot of
auto-doc
features, where our reference docs are created based on the doc strings of our functions. For most of the "important" stuff like:We should have better docstrings for our docs to auto-generate
The text was updated successfully, but these errors were encountered: