search

happyleavesaoc / aoc-mgz

Age of Empires II recorded game parsing and summarization in Python 3.
MIT License
197 stars 42 forks source link

Consider add documentation? #97

Open HuangFuSL opened 1 year ago

HuangFuSL commented 1 year ago

Hi! I'm collecting aoe2 ranked game records and using this library to parse them. However when I want to extract specified data from records, I'm getting lost in APIs and sometimes I have to refer to the source code to make sure which method to use. I'm wondering if it would be possible to add a documentation site or just a markdown page containing a quick reference of what we can inspect using this module and corresponding APIs in detail?

M1ngXU commented 1 year ago

the main docs are in the readme/code 11, but yeah, some doc strings would be great