From 0d45e45c8a728334763ae653ee8f5f643e5ea4f8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <davbe125@student.liu.se>
Date: Tue, 11 Sep 2018 08:15:36 +0200
Subject: [PATCH] Add documentation on is_being_constructed and is_completed
---
docs/unit.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/unit.rst b/docs/unit.rst
index 003e12df7..b5e94e274 100644
--- a/docs/unit.rst
+++ b/docs/unit.rst
@@ -26,9 +26,15 @@ Unit
.. autoattribute:: id
.. autoattribute:: is_alive
.. autoattribute:: is_being_constructed
+
+ Returns build_progress > 0
+
.. autoattribute:: is_burrowed
.. autoattribute:: is_cloaked
.. autoattribute:: is_completed
+
+ Returns build_progress >= 1
+
.. autoattribute:: is_constructing
.. autoattribute:: is_flying
.. autoattribute:: is_idle
--
GitLab