From b08b60f6c45ec04fa7b90e0997f88257ed490c6b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <davbe125@student.liu.se>
Date: Mon, 13 Aug 2018 07:29:40 +0200
Subject: [PATCH] Add TODOs from short review
---
docs/constants.rst | 2 ++
docs/idabot.rst | 2 +-
docs/index.rst | 6 ++++++
docs/managers.rst | 4 ++++
4 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/docs/constants.rst b/docs/constants.rst
index d02278e..4bd6767 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 569930f..f751915 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 8572292..f799f95 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 2e861ce..e7fdcea 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:
--
GitLab