diff --git a/docs/constants.rst b/docs/constants.rst index d02278e14ff31fc4a27c4e256f58b478036750c1..4bd6767fa211acc280a673ffd2b25a56c25be4ee 100644 --- a/docs/constants.rst +++ b/docs/constants.rst @@ -28,6 +28,8 @@ Difficulty Race ---- +" TODO: Order these explicitly + .. autoclass:: library.Race :members: :undoc-members: diff --git a/docs/idabot.rst b/docs/idabot.rst index 569930f333b4d75ff5916fef13e902a6f7fd255d..f75191563a44a87b9bb97678a7864fa365152723 100644 --- a/docs/idabot.rst +++ b/docs/idabot.rst @@ -32,7 +32,7 @@ IDABot .. method:: IDABot.on_game_start(self) This method when Starcraft has stared, when you inherit it you have to - call the parent's on_step method in order to make it work (see + call the parent's on_game_start method in order to make it work (see :ref:`gettingstarted`). .. method:: IDABot.on_step(self) diff --git a/docs/index.rst b/docs/index.rst index 8572292670b56551db1ca1c6c124b64fd868dd77..f799f9579d9ea28443e0f3e2da8f4a88823b23a7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,12 @@ If you are looking for something specific, you can either check the If you want to know about a certain topic, check the table of contents below this paragraph. +.. TODO: Add information about tree.json + +.. TODO: How to setup basic project in Pycharm + +.. TODO: Base repos for C++ AI and Python AI + Table of contents ----------------- diff --git a/docs/managers.rst b/docs/managers.rst index 2e861ce11977827b0a58b5578d48ecd10dc1498f..e7fdceaa675a9d7de9ab9f84cb29317b7f2d5226 100644 --- a/docs/managers.rst +++ b/docs/managers.rst @@ -1,6 +1,8 @@ Managers ======== +.. TODO: Rename *Manager to BaseLocation + The original `CommandCenter`_ bot uses managers to do everything, having managers manage workers, building, controlling military etc. In this API we have removed all the control related managers and only kept the managers @@ -107,6 +109,8 @@ DistanceMap BuildingPlacer -------------- +.. TODO: get_refinery_position should work on all bases + .. autoclass:: library.BuildingPlacer :members: :undoc-members: