Merge pull request #21767 from anntzer/macosxdocs

jklymak · web-flow · commit 728f0e483f93 · 2021-11-27T01:55:35.000-08:00
Inherit many macos backend docstrings.
diff --git a/src/_macosx.m b/src/_macosx.m
@@ -539,7 +539,7 @@ static CGFloat _get_device_scale(CGContextRef cr)
     {"flush_events",
      (PyCFunction)FigureCanvas_flush_events,
      METH_NOARGS,
-     "Flush the GUI events for the figure."
+     NULL,  // docstring inherited.
     },
     {"set_rubberband",
      (PyCFunction)FigureCanvas_set_rubberband,
@@ -554,12 +554,12 @@ static CGFloat _get_device_scale(CGContextRef cr)
     {"start_event_loop",
      (PyCFunction)FigureCanvas_start_event_loop,
      METH_KEYWORDS | METH_VARARGS,
-     "Runs the event loop until the timeout or until stop_event_loop is called.\n",
+     NULL,  // docstring inherited.
     },
     {"stop_event_loop",
      (PyCFunction)FigureCanvas_stop_event_loop,
      METH_NOARGS,
-     "Stops the event loop that was started by start_event_loop.\n",
+     NULL,  // docstring inherited.
     },
     {NULL}  /* Sentinel */
 };
@@ -782,27 +782,27 @@ static CGFloat _get_device_scale(CGContextRef cr)
     {"show",
      (PyCFunction)FigureManager_show,
      METH_NOARGS,
-     "Shows the window associated with the figure manager."
+     NULL,  // docstring inherited.
     },
     {"destroy",
      (PyCFunction)FigureManager_destroy,
      METH_NOARGS,
-     "Closes the window associated with the figure manager."
+     NULL,  // docstring inherited.
     },
     {"set_window_title",
      (PyCFunction)FigureManager_set_window_title,
      METH_VARARGS,
-     "Sets the title of the window associated with the figure manager."
+     NULL,  // docstring inherited.
     },
     {"get_window_title",
      (PyCFunction)FigureManager_get_window_title,
      METH_NOARGS,
-     "Returns the title of the window associated with the figure manager."
+     NULL,  // docstring inherited.
     },
     {"resize",
      (PyCFunction)FigureManager_resize,
      METH_VARARGS,
-     "Resize the window (in pixels)."
+     NULL,  // docstring inherited.
     },
     {NULL}  /* Sentinel */
 };
@@ -1098,7 +1098,7 @@ -(void)save_figure:(id)sender { gil_call_method(toolbar, "save_figure"); }
     {"set_message",
      (PyCFunction)NavigationToolbar2_set_message,
      METH_VARARGS,
-     "Set the message to be displayed on the toolbar."
+     NULL,  // docstring inherited.
     },
     {NULL}  /* Sentinel */
 };
@@ -1991,12 +1991,12 @@ static void context_cleanup(const void* info)
     {"_timer_start",
      (PyCFunction)Timer__timer_start,
      METH_VARARGS,
-     "Initialize and start the timer."
+     NULL,  // docstring inherited.
     },
     {"_timer_stop",
      (PyCFunction)Timer__timer_stop,
      METH_NOARGS,
-     "Stop the timer."
+     NULL,  // docstring inherited.
     },
     {NULL}  /* Sentinel */
 };
