Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider add documentation? #97

Open
HuangFuSL opened this issue May 21, 2023 · 1 comment
Open

Consider add documentation? #97

HuangFuSL opened this issue May 21, 2023 · 1 comment

Comments

@HuangFuSL
Copy link

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
Copy link

M1ngXU commented May 21, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants