wowsims / sod

World of Warcraft Classic Season of Discovery simulations.
https://wowsims.github.io/sod/
MIT License
13 stars 44 forks source link

Documentation #953

Open tmharwood opened 2 months ago

tmharwood commented 2 months ago

Is your feature request related to a problem? Please describe.

A lot of files and functions are missing documentation, which makes it a little difficult to understand what is going on within each file without digging through code.

Describe the solution you'd like Documentation / docstrings would be helpful! If not for every function (there are a lot, this would be very time consuming) then at least it would help to have some sort of docstring in each file describing what the purpose of that file is. It'd help onboard newcomers to the project a little bit better.

Additional context Go's best practices involve comments for all top-level exported names as well as unexported non-trivial function declarations