Document the code - Githubissues

Team-Creative-Name / Plexi

A Discord bot that integrates with Ombi

GNU Affero General Public License v3.0

1 stars 1 forks source link

Document the code #24

Closed collectioncard closed 4 years ago

collectioncard commented 4 years ago

All of the code needs documentation. We CANNOT release v1.0 without doing so. Its starting to get to the point where I am losing track of some of the lesser edited parts of Plexi.

collectioncard commented 4 years ago

Classes that require documentation:

[x] Settings.java | Done in 54d6fcf
[x] Paginator.java | Done in cedb5b9
[x] OmbiCallers.java | Done in 7b16dd0
[x] EmbedManager | Done in bc1cd20

These are the classes that are accessed from other classes the most. None of the others are really supposed to be accessed a bunch and are of lesser importance.

collectioncard commented 4 years ago

Basic Documentation is complete. We still need to add basic class descriptions to the Ombi Template Headers.

Done in a251a84

Should be good to close and pull.