python-sc2 icon indicating copy to clipboard operation
python-sc2 copied to clipboard

Organizational thought for the wiki (individual pages for classes)

Open B204L opened this issue 6 years ago • 1 comments

It may be helpful to have pages dedicated to the more commonly used classes (for example: game_state, unit, units etc) where the tables of applicable properties, methods etc can be found. I often find myself searching for properties / attributes or using trial and error to see if something will work, e.g. .position is a property of .unit and not .units.

B204L avatar Feb 14 '19 19:02 B204L

I think we actually might need to migrate the wiki to individual markdown pages that live inside the repository. You cannot do PRs to the wiki, and it's starting to be an issue.

This is an useful change as well. As a part of the migration mentioned above, it might be useful to automatically generate method documentation directly from the Python code.

Dentosal avatar Feb 16 '19 03:02 Dentosal