Fix docstrings

laggykiller · Sep 22, 2023 · 74da176 · 74da176
1 parent 0e6ed6e
commit 74da176
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: laggykiller
diff --git a/src/apngasm_python.cpp b/src/apngasm_python.cpp
@@ -68,7 +68,7 @@ NB_MODULE(MODULE_NAME, m) {
     R"pbdoc(
     Creates an APNGFrame from a bitmapped array of RBG pixel data.
     
-    :param int pixels: The RGB pixel data, expressed as 1D numpy array.
+    :param numpy.ndarray pixels: The RGB pixel data, expressed as 1D numpy array.
     :param int width: The width of the pixel data.
     :param int height: The height of the pixel data.
     :param numpy.ndarray trns_color: An array of transparency data, expressed as 1D numpy array.
@@ -103,11 +103,11 @@ NB_MODULE(MODULE_NAME, m) {
     R"pbdoc(
     Creates an APNGFrame from a bitmapped array of RBGA pixel data.
     
-    :param pixels: The RGBA pixel data, expressed as 1D numpy array.
-    :param width: The width of the pixel data.
-    :param height: The height of the pixel data.
-    :param delay_num: The delay numerator for this frame (defaults to DEFAULT_FRAME_NUMERATOR)
-    :param delay_den: The delay denominator for this frame (defaults to DEFAULT_FRAME_DENMINATOR)
+    :param numpy.ndarray pixels: The RGBA pixel data, expressed as 1D numpy array.
+    :param int width: The width of the pixel data.
+    :param int height: The height of the pixel data.
+    :param int delay_num: The delay numerator for this frame (defaults to DEFAULT_FRAME_NUMERATOR)
+    :param int delay_den: The delay denominator for this frame (defaults to DEFAULT_FRAME_DENMINATOR)
 
     :return: A APNGFrame object.
     :rtype: apngasm_python._apngasm_python.APNGFrame