FIX: more comments

jklymak · jklymak · commit f542c0b327e5 · 2020-10-08T09:29:58.000-07:00
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1472,8 +1472,11 @@ def subfigures(self, nrows=1, ncols=1, squeeze=True,
                    width_ratios=None, height_ratios=None,
                    **kwargs):
         """
-        Add a subfigure to this figure or subfigure.  A subfigure has the same
-        artist methods as a figure, and is logically the same as a figure.
+        Add a subfigure to this figure or subfigure.
+
+        A subfigure has the same artist methods as a figure, and is logically
+        the same as a figure, but cannot print itself.
+        See :doc:`/gallery/subplots_axes_and_figures/subfigures`.
 
         Parameters
         ----------
@@ -2056,6 +2059,7 @@ def __init__(self, parent, subplotspec, *,
             facecolor=facecolor, edgecolor=edgecolor, linewidth=linewidth,
             # Don't let the figure patch influence bbox calculation.
             in_layout=False, transform=self.transSubfigure)
+        self._set_artist_props(self.patch)
         self.patch.set_antialiased(False)
 
         if parent._layoutgrid is not None:
@@ -2094,12 +2098,13 @@ def _redo_transform_rel_fig(self, bbox=None):
         heightf = np.sum(hr[self._subplotspec.rowspan]) / np.sum(hr)
 
         x0 = 0
-        if self._subplotspec.colspan[0] > 0:
-            x0 += np.sum(wr[self._subplotspec.colspan[0] - 1]) / np.sum(wr)
+        if not self._subplotspec.is_first_col():
+            x0 += np.sum(wr[self._subplotspec.colspan.start - 1]) / np.sum(wr)
 
         y0 = 0
-        if self._subplotspec.rowspan[-1] < nrows - 1:
-            y0 += 1 - np.sum(hr[self._subplotspec.rowspan[-1]-1]) / np.sum(hr)
+        if not self._subplotspec.is_last_row():
+            y0 += 1 - (np.sum(hr[self._subplotspec.rowspan.stop - 1]) /
+                       np.sum(hr))
 
         if self.bbox_relative is None:
             self.bbox_relative = Bbox.from_bounds(x0, y0, widthf, heightf)
@@ -2108,9 +2113,27 @@ def _redo_transform_rel_fig(self, bbox=None):
             self.bbox_relative.p1 = (x0 + widthf, y0 + heightf)
 
     def get_constrained_layout(self):
+        """
+        Return whether constrained layout is being used.
+
+        See :doc:`/tutorials/intermediate/constrainedlayout_guide`.
+        """
         return self._parent.get_constrained_layout()
 
     def get_constrained_layout_pads(self, relative=False):
+        """
+        Get padding for ``constrained_layout``.
+
+        Returns a list of ``w_pad, h_pad`` in inches and
+        ``wspace`` and ``hspace`` as fractions of the subplot.
+
+        See :doc:`/tutorials/intermediate/constrainedlayout_guide`.
+
+        Parameters
+        ----------
+        relative : bool
+            If `True`, then convert from inches to figure relative.
+        """
         return self._parent.get_constrained_layout_pads(relative=relative)
 
     def init_layoutgrid(self):
@@ -2132,6 +2155,12 @@ def get_axes(self):
         """
         Return a list of axes in the SubFigure. You can access and modify the
         axes in the Figure through this list.
+
+        Do not modify the list itself. Instead, use `~.SubFigure.add_axes`,
+        `~.SubFigure.add_subplot` or `~.SubFigure.delaxes` to add or remove an
+        axes.
+
+        Note: This is equivalent to the property `~.Figure.axes`.
         """
         return self._localaxes.as_list()
 
@@ -2285,7 +2314,6 @@ def __init__(self,
         self.patch.set_antialiased(False)
 
         FigureCanvasBase(self)  # Set self.canvas.
-        self._suptitle = None
 
         if subplotpars is None:
             subplotpars = SubplotParams()
@@ -2303,7 +2331,6 @@ def __init__(self,
         self._cachedRenderer = None
 
         self.set_constrained_layout(constrained_layout)
-        self.subfigs = []
 
         # groupers to keep track of x and y labels we want to align.
         # see self.align_xlabels and self.align_ylabels and
