search

NinjaCheetah / libWiiPy

A modern Python library for handling files and formats used by the Wii.
https://docs.ninjacheetah.dev/
MIT License
10 stars 1 forks source link

Documentation: Fully document all classes and methods in the source #8

Closed NinjaCheetah closed 9 months ago

NinjaCheetah commented 9 months ago

This will allow for automatically generating documentation based on the source code, and makes things much much easier on any developer trying to use the library. With this documentation written, it is also possible to use Python's help() method to retrieve the documentation for a class or method.

An example of this exists in wad.py on the full_docs branch.

NinjaCheetah commented 9 months ago

I missed the class in ticket.py, and if I don’t reopen this I will forget.

NinjaCheetah commented 9 months ago

Closing this for real now, as I feel like everything currently implemented is very well documented. This will of course be an ongoing thing as development continues.