emipa606 / GradualRomance

A relationship mod for Rimworld
MIT License
1 stars 1 forks source link

Code cleanup: Code documentation #5

Closed thailyn closed 10 months ago

thailyn commented 10 months ago

My apologies if this is excessively petty, but, when I try to understand existing code bases, I like to add tons of documentation and make small optimizations piece by piece. This PR itself doesn't really help improve the code, but hopefully lays the foundation for some improvements later on. I also find that, when I don't implicitly understand some code (especially when there are calculations involved), it usually means some other people don't, either, so the additional documentation can be helpful.

However, in AgeCalculationUtility, I did notice some specific possible improvements that could be made, even if they are just removing assumptions the code makes. I plan on revisiting these TODOs when I have a better understanding of the code.

emipa606 commented 10 months ago

Fixed in 3f9c3bc