Skip to content
This repository has been archived by the owner on Apr 22, 2024. It is now read-only.

Add documentation (docstrings) to all methods #57

Open
jonespm opened this issue Apr 3, 2020 · 0 comments
Open

Add documentation (docstrings) to all methods #57

jonespm opened this issue Apr 3, 2020 · 0 comments
Labels
📖 documentation Improvements or additions to documentation 📈 enhancement New feature or request

Comments

@jonespm
Copy link
Member

jonespm commented Apr 3, 2020

All methods should include documentation about what they do. Most of this code doesn't have that.

We've been using the Sphinx format for other projects
https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

This will fix some Codacy issues related to docstrings and also make the code easier to maintain in the future.

@jonespm jonespm added the 📈 enhancement New feature or request label Apr 29, 2020
@jonespm jonespm added the 📖 documentation Improvements or additions to documentation label Jun 12, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📖 documentation Improvements or additions to documentation 📈 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant