From 40ade4d98d632b68cd1060b793a2220556094dd0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <davbe125@student.liu.se>
Date: Tue, 10 Jul 2018 14:14:05 +0200
Subject: [PATCH] Add docstring on unclear property
---
python-api-src/lib_unittype.cpp | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/python-api-src/lib_unittype.cpp b/python-api-src/lib_unittype.cpp
index b8aa24d..25354d8 100644
--- a/python-api-src/lib_unittype.cpp
+++ b/python-api-src/lib_unittype.cpp
@@ -12,7 +12,7 @@ void define_unittype(py::module & m)
.def_property_readonly("race", &UnitType::getRace)
.def_property_readonly("is_valid", &UnitType::isValid)
.def_property_readonly("is_building", &UnitType::isBuilding)
- .def_property_readonly("is_combat_unit", &UnitType::isCombatUnit)
+ .def_property_readonly("is_combat_unit", &UnitType::isCombatUnit, "The unit is not any of the following: worker, supply provider, building, larva, egg")
.def_property_readonly("is_supply_provider", &UnitType::isSupplyProvider)
.def_property_readonly("is_resource_depot", &UnitType::isResourceDepot)
.def_property_readonly("is_refinery", &UnitType::isRefinery)
--
GitLab