forked from maxpareschi/LabLib
-
Notifications
You must be signed in to change notification settings - Fork 2
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
Refining Docstrings for Code API Enhancement #15
Labels
documentation
Improvements or additions to documentation
Comments
here is great example of the docsting style, taken from here https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example:
|
Merged
looking at the example, should we remove the type hints from signatures or rather add more? |
definitelly rather more please :) |
your wish is my command :D |
Merged
Merged
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description:
In order to enhance our code API, it is essential that we refine the docstrings for every method and class. Additionally, each module category's
__init__.py
file should contain a clear and concise docstring explaining its purpose. This initiative will be particularly beneficial as we transition to using Sphinx for documentation generation.Steps to Reproduce:
__init__.py
file includes a descriptive docstring.Expected Outcome:
Improved code readability and documentation quality, facilitating better understanding and usage of the API.
The text was updated successfully, but these errors were encountered: