-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
Description
Currently, this package's documentation is limited to the README file provided in the repository/distributed bundle. This isn't useful for people programming in an editor or using the help function. The following changes need to be made:
- Add a changelog of changes during each release.
- Add PEP 526-style instance variable annotations for each of the public fields on the
Pokemonobject. - Add docstrings to all (if possible) modules/classes/methods/attributes.
- (Optional) Host generated documentation on a website such as readthedocs.
This will probably be pushed as a minor version update since it doesn't change the API of the package.