Merge pull request #200 from Hoikas/type-hints

The Revenge of Tsar Hoikas: PyHSPlasma Type Hints.
H-uru · Feb 25, 2021 · 486cfc0 · 486cfc0
2 parents 819bd34 + 99e0a5d
commit 486cfc0
Show file tree

Hide file tree

Showing 5 changed files with 5,623 additions and 7 deletions.
diff --git a/Python/CMakeLists.txt b/Python/CMakeLists.txt
@@ -767,6 +767,7 @@ if(NOT WIN32)
     install(TARGETS PyHSPlasma
             DESTINATION ${_PYTHON_LIB_DIR}
     )
+    install(FILES PyHSPlasma.pyi DESTINATION ${_PYTHON_LIB_DIR})
 else()
     set_target_properties(PyHSPlasma PROPERTIES
                           SUFFIX ".pyd"
@@ -777,6 +778,7 @@ else()
             LIBRARY DESTINATION lib
             ARCHIVE DESTINATION lib
     )
+    install(FILES PyHSPlasma.pyi DESTINATION bin)
 endif()
 
 #Visual studio source grouping

diff --git a/Python/PRP/Geometry/pyDrawableSpans.cpp b/Python/PRP/Geometry/pyDrawableSpans.cpp
@@ -78,8 +78,8 @@ PY_METHOD_VA(DrawableSpans, deleteBufferGroup,
 }
 
 PY_METHOD_VA(DrawableSpans, getVerts,
-    "Params: buffer, idx\n"
-    "Retrieves a list of verts from the specified buffer and group")
+    "Params: icicle\n"
+    "Retrieves a list of verts from the specified icicle")
 {
     pyIcicle* ice;
     if (!PyArg_ParseTuple(args, "O", &ice)) {
@@ -98,9 +98,8 @@ PY_METHOD_VA(DrawableSpans, getVerts,
 }
 
 PY_METHOD_VA(DrawableSpans, getIndices,
-    "Params: buffer, idx\n"
-    "Retrieves a list of face-vertex indices (ungrouped) from the specified\n"
-    "buffer and group")
+    "Params: icicle\n"
+    "Retrieves a list of face-vertex indices (ungrouped) from the specified icicle")
 {
     pyIcicle* ice;
     if (!PyArg_ParseTuple(args, "O", &ice)) {

diff --git a/Python/PRP/Message/pyMessageWithCallbacks.cpp b/Python/PRP/Message/pyMessageWithCallbacks.cpp
@@ -23,7 +23,7 @@
 PY_PLASMA_NEW(MessageWithCallbacks, plMessageWithCallbacks)
 
 PY_METHOD_VA(MessageWithCallbacks, addCallback,
-    "Params: key\n"
+    "Params: msg\n"
     "Adds a callback message")
 {
     PyObject* msg;

diff --git a/Python/PRP/Modifier/pyLogicModBase.cpp b/Python/PRP/Modifier/pyLogicModBase.cpp
@@ -32,7 +32,7 @@ PY_METHOD_NOARGS(LogicModBase, clearCommands, "Remove all commands")
 }
 
 PY_METHOD_VA(LogicModBase, addCommand,
-    "Params: key\n"
+    "Params: msg\n"
     "Add a command")
 {
     pyMessage* msg;