Skip to content
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

Improve documentation for this package #8

Open
arnavb opened this issue Feb 8, 2020 · 2 comments
Open

Improve documentation for this package #8

arnavb opened this issue Feb 8, 2020 · 2 comments
Assignees
Labels
documentation enhancement New feature or request

Comments

@arnavb
Copy link
Owner

arnavb commented Feb 8, 2020

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.

@Acryptarch
Copy link

You have typo in your readme. I think you say "intt" instead of "int". Idk if this is important enough for you to care about though.

@arnavb
Copy link
Owner Author

arnavb commented Aug 7, 2020

@Acryptarch I'll fix that in the next documentation release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants