Merge pull request matplotlib#21746 from anntzer/cdoc

Fix/add docstring signatures to many C++ methods.

Author: timhoffm

src/_contour_wrapper.cpp

@@ -77,7 +77,7 @@ static void PyQuadContourGenerator_dealloc(PyQuadContourGenerator* self)
 }
 
 const char* PyQuadContourGenerator_create_contour__doc__ =
-    "create_contour(level)\n"
+    "create_contour(self, level)\n"
     "--\n\n"
     "Create and return a non-filled contour.";
 
@@ -94,7 +94,7 @@ static PyObject* PyQuadContourGenerator_create_contour(PyQuadContourGenerator* s
 }
 
 const char* PyQuadContourGenerator_create_filled_contour__doc__ =
-    "create_filled_contour(lower_level, upper_level)\n"
+    "create_filled_contour(self, lower_level, upper_level)\n"
     "--\n\n"
     "Create and return a filled contour";
 
@@ -123,13 +123,19 @@ static PyObject* PyQuadContourGenerator_create_filled_contour(PyQuadContourGener
 static PyTypeObject* PyQuadContourGenerator_init_type(PyObject* m, PyTypeObject* type)
 {
     static PyMethodDef methods[] = {
-        {"create_contour", (PyCFunction)PyQuadContourGenerator_create_contour, METH_VARARGS, PyQuadContourGenerator_create_contour__doc__},
-        {"create_filled_contour", (PyCFunction)PyQuadContourGenerator_create_filled_contour, METH_VARARGS, PyQuadContourGenerator_create_filled_contour__doc__},
+        {"create_contour",
+         (PyCFunction)PyQuadContourGenerator_create_contour,
+         METH_VARARGS,
+         PyQuadContourGenerator_create_contour__doc__},
+        {"create_filled_contour",
+         (PyCFunction)PyQuadContourGenerator_create_filled_contour,
+         METH_VARARGS,
+         PyQuadContourGenerator_create_filled_contour__doc__},
         {NULL}
     };
 
     memset(type, 0, sizeof(PyTypeObject));
-    type->tp_name = "matplotlib.QuadContourGenerator";
+    type->tp_name = "matplotlib._contour.QuadContourGenerator";
     type->tp_doc = PyQuadContourGenerator_init__doc__;
     type->tp_basicsize = sizeof(PyQuadContourGenerator);
     type->tp_dealloc = (destructor)PyQuadContourGenerator_dealloc;

src/_image_wrapper.cpp

@@ -9,7 +9,8 @@
  * */
 
 const char* image_resample__doc__ =
-"resample(input_array, output_array, matrix, interpolation=NEAREST, alpha=1.0, norm=False, radius=1)\n\n"
+"resample(input_array, output_array, matrix, interpolation=NEAREST, alpha=1.0, norm=False, radius=1)\n"
+"--\n\n"
 
 "Resample input_array, blending it in-place into output_array, using an\n"
 "affine transformation.\n\n"

src/ft2font_wrapper.cpp

@@ -62,7 +62,7 @@ static void PyFT2Image_dealloc(PyFT2Image *self)
 }
 
 const char *PyFT2Image_draw_rect__doc__ =
-    "draw_rect(x0, y0, x1, y1)\n"
+    "draw_rect(self, x0, y0, x1, y1)\n"
     "--\n\n"
     "Draw an empty rectangle to the image.\n";
 
@@ -80,7 +80,7 @@ static PyObject *PyFT2Image_draw_rect(PyFT2Image *self, PyObject *args)
 }
 
 const char *PyFT2Image_draw_rect_filled__doc__ =
-    "draw_rect_filled(x0, y0, x1, y1)\n"
+    "draw_rect_filled(self, x0, y0, x1, y1)\n"
     "--\n\n"
     "Draw a filled rectangle to the image.\n";
 
@@ -421,7 +421,7 @@ static void PyFT2Font_dealloc(PyFT2Font *self)
 }
 
 const char *PyFT2Font_clear__doc__ =
-    "clear()\n"
+    "clear(self)\n"
     "--\n\n"
     "Clear all the glyphs, reset for a new call to `.set_text`.\n";
 
@@ -433,7 +433,7 @@ static PyObject *PyFT2Font_clear(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_set_size__doc__ =
-    "set_size(ptsize, dpi)\n"
+    "set_size(self, ptsize, dpi)\n"
     "--\n\n"
     "Set the point size and dpi of the text.\n";
 
@@ -452,7 +452,7 @@ static PyObject *PyFT2Font_set_size(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_set_charmap__doc__ =
-    "set_charmap(i)\n"
+    "set_charmap(self, i)\n"
     "--\n\n"
     "Make the i-th charmap current.\n";
 
@@ -470,7 +470,7 @@ static PyObject *PyFT2Font_set_charmap(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_select_charmap__doc__ =
-    "select_charmap(i)\n"
+    "select_charmap(self, i)\n"
     "--\n\n"
     "Select a charmap by its FT_Encoding number.\n";
 
@@ -488,7 +488,7 @@ static PyObject *PyFT2Font_select_charmap(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_kerning__doc__ =
-    "get_kerning(left, right, mode)\n"
+    "get_kerning(self, left, right, mode)\n"
     "--\n\n"
     "Get the kerning between *left* and *right* glyph indices.\n"
     "*mode* is a kerning mode constant:\n"
@@ -511,7 +511,7 @@ static PyObject *PyFT2Font_get_kerning(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_set_text__doc__ =
-    "set_text(string, angle, flags=32)\n"
+    "set_text(self, string, angle, flags=32)\n"
     "--\n\n"
     "Set the text *string* and *angle*.\n"
     "*flags* can be a bitwise-or of the LOAD_XXX constants;\n"
@@ -583,7 +583,7 @@ static PyObject *PyFT2Font_set_text(PyFT2Font *self, PyObject *args, PyObject *k
 }
 
 const char *PyFT2Font_get_num_glyphs__doc__ =
-    "get_num_glyphs()\n"
+    "get_num_glyphs(self)\n"
     "--\n\n"
     "Return the number of loaded glyphs.\n";
 
@@ -593,7 +593,7 @@ static PyObject *PyFT2Font_get_num_glyphs(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_load_char__doc__ =
-    "load_char(charcode, flags=32)\n"
+    "load_char(self, charcode, flags=32)\n"
     "--\n\n"
     "Load character with *charcode* in current fontfile and set glyph.\n"
     "*flags* can be a bitwise-or of the LOAD_XXX constants;\n"
@@ -632,7 +632,7 @@ static PyObject *PyFT2Font_load_char(PyFT2Font *self, PyObject *args, PyObject *
 }
 
 const char *PyFT2Font_load_glyph__doc__ =
-    "load_glyph(glyphindex, flags=32)\n"
+    "load_glyph(self, glyphindex, flags=32)\n"
     "--\n\n"
     "Load character with *glyphindex* in current fontfile and set glyph.\n"
     "*flags* can be a bitwise-or of the LOAD_XXX constants;\n"
@@ -671,7 +671,7 @@ static PyObject *PyFT2Font_load_glyph(PyFT2Font *self, PyObject *args, PyObject
 }
 
 const char *PyFT2Font_get_width_height__doc__ =
-    "get_width_height()\n"
+    "get_width_height(self)\n"
     "--\n\n"
     "Get the width and height in 26.6 subpixels of the current string set by `.set_text`.\n"
     "The rotation of the string is accounted for.  To get width and height\n"
@@ -687,7 +687,7 @@ static PyObject *PyFT2Font_get_width_height(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_bitmap_offset__doc__ =
-    "get_bitmap_offset()\n"
+    "get_bitmap_offset(self)\n"
     "--\n\n"
     "Get the (x, y) offset in 26.6 subpixels for the bitmap if ink hangs left or below (0, 0).\n"
     "Since Matplotlib only supports left-to-right text, y is always 0.\n";
@@ -702,7 +702,7 @@ static PyObject *PyFT2Font_get_bitmap_offset(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_descent__doc__ =
-    "get_descent()\n"
+    "get_descent(self)\n"
     "--\n\n"
     "Get the descent in 26.6 subpixels of the current string set by `.set_text`.\n"
     "The rotation of the string is accounted for.  To get the descent\n"
@@ -718,7 +718,7 @@ static PyObject *PyFT2Font_get_descent(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_draw_glyphs_to_bitmap__doc__ =
-    "draw_glyphs_to_bitmap()\n"
+    "draw_glyphs_to_bitmap(self, antialiased=True)\n"
     "--\n\n"
     "Draw the glyphs that were loaded by `.set_text` to the bitmap.\n"
     "The bitmap size will be automatically set to include the glyphs.\n";
@@ -739,7 +739,7 @@ static PyObject *PyFT2Font_draw_glyphs_to_bitmap(PyFT2Font *self, PyObject *args
 }
 
 const char *PyFT2Font_get_xys__doc__ =
-    "get_xys()\n"
+    "get_xys(self, antialiased=True)\n"
     "--\n\n"
     "Get the xy locations of the current glyphs.\n";
 
@@ -760,7 +760,7 @@ static PyObject *PyFT2Font_get_xys(PyFT2Font *self, PyObject *args, PyObject *kw
 }
 
 const char *PyFT2Font_draw_glyph_to_bitmap__doc__ =
-    "draw_glyph_to_bitmap(bitmap, x, y, glyph)\n"
+    "draw_glyph_to_bitmap(self, image, x, y, glyph, antialiased=True)\n"
     "--\n\n"
     "Draw a single glyph to the bitmap at pixel locations x, y\n"
     "Note it is your responsibility to set up the bitmap manually\n"
@@ -801,7 +801,7 @@ static PyObject *PyFT2Font_draw_glyph_to_bitmap(PyFT2Font *self, PyObject *args,
 }
 
 const char *PyFT2Font_get_glyph_name__doc__ =
-    "get_glyph_name(index)\n"
+    "get_glyph_name(self, index)\n"
     "--\n\n"
     "Retrieve the ASCII name of a given glyph *index* in a face.\n"
     "\n"
@@ -821,7 +821,7 @@ static PyObject *PyFT2Font_get_glyph_name(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_charmap__doc__ =
-    "get_charmap()\n"
+    "get_charmap(self)\n"
     "--\n\n"
     "Return a dict that maps the character codes of the selected charmap\n"
     "(Unicode by default) to their corresponding glyph indices.\n";
@@ -852,7 +852,7 @@ static PyObject *PyFT2Font_get_charmap(PyFT2Font *self, PyObject *args)
 
 
 const char *PyFT2Font_get_char_index__doc__ =
-    "get_char_index(codepoint)\n"
+    "get_char_index(self, codepoint)\n"
     "--\n\n"
     "Return the glyph index corresponding to a character *codepoint*.\n";
 
@@ -872,7 +872,7 @@ static PyObject *PyFT2Font_get_char_index(PyFT2Font *self, PyObject *args)
 
 
 const char *PyFT2Font_get_sfnt__doc__ =
-    "get_sfnt()\n"
+    "get_sfnt(self)\n"
     "--\n\n"
     "Load the entire SFNT names table, as a dict whose keys are\n"
     "(platform-ID, ISO-encoding-scheme, language-code, and description)\n"
@@ -933,7 +933,7 @@ static PyObject *PyFT2Font_get_sfnt(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_name_index__doc__ =
-    "get_name_index(name)\n"
+    "get_name_index(self, name)\n"
     "--\n\n"
     "Return the glyph index of a given glyph *name*.\n"
     "The glyph index 0 means 'undefined character code'.\n";
@@ -950,7 +950,7 @@ static PyObject *PyFT2Font_get_name_index(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_ps_font_info__doc__ =
-    "get_ps_font_info()\n"
+    "get_ps_font_info(self)\n"
     "--\n\n"
     "Return the information in the PS Font Info structure.\n";
 
@@ -977,7 +977,7 @@ static PyObject *PyFT2Font_get_ps_font_info(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_sfnt_table__doc__ =
-    "get_sfnt_table(name)\n"
+    "get_sfnt_table(self, name)\n"
     "--\n\n"
     "Return one of the following SFNT tables: head, maxp, OS/2, hhea, "
     "vhea, post, or pclt.\n";
@@ -1279,7 +1279,7 @@ static PyObject *PyFT2Font_get_sfnt_table(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_path__doc__ =
-    "get_path()\n"
+    "get_path(self)\n"
     "--\n\n"
     "Get the path data from the currently loaded glyph as a tuple of vertices, "
     "codes.\n";
@@ -1290,7 +1290,7 @@ static PyObject *PyFT2Font_get_path(PyFT2Font *self, PyObject *args)
 }
 
 const char *PyFT2Font_get_image__doc__ =
-    "get_image()\n"
+    "get_image(self)\n"
     "--\n\n"
     "Return the underlying image buffer for this font object.\n";