Skip to content

Improve documentation for this package #8

@arnavb

Description

@arnavb

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 Pokemon object.
  • 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.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions