Merge pull request #20333 from anntzer/legend-init

timhoffm · web-flow · commit dd08ab0f8173 · 2021-05-29T18:02:11.000+02:00
Better align param comments in `Legend.__init__` signature.
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -301,50 +301,44 @@ def __str__(self):
         return "Legend"
 
     @docstring.dedent_interpd
-    def __init__(self, parent, handles, labels,
-                 loc=None,
-                 numpoints=None,    # the number of points in the legend line
-                 markerscale=None,  # the relative size of legend markers
-                                    # vs. original
-                 markerfirst=True,  # controls ordering (left-to-right) of
-                                    # legend marker and label
-                 scatterpoints=None,    # number of scatter points
-                 scatteryoffsets=None,
-                 prop=None,          # properties for the legend texts
-                 fontsize=None,      # keyword to set font size directly
-                 labelcolor=None,    # keyword to set the text color
-
-                 # spacing & pad defined as a fraction of the font-size
-                 borderpad=None,      # the whitespace inside the legend border
-                 labelspacing=None,   # the vertical space between the legend
-                                      # entries
-                 handlelength=None,   # the length of the legend handles
-                 handleheight=None,   # the height of the legend handles
-                 handletextpad=None,  # the pad between the legend handle
-                                      # and text
-                 borderaxespad=None,  # the pad between the axes and legend
-                                      # border
-                 columnspacing=None,  # spacing between columns
-
-                 ncol=1,     # number of columns
-                 mode=None,  # mode for horizontal distribution of columns.
-                             # None, "expand"
-
-                 fancybox=None,  # True use a fancy box, false use a rounded
-                                 # box, none use rc
-                 shadow=None,
-                 title=None,  # set a title for the legend
-                 title_fontsize=None,  # the font size for the title
-                 framealpha=None,  # set frame alpha
-                 edgecolor=None,  # frame patch edgecolor
-                 facecolor=None,  # frame patch facecolor
-
-                 bbox_to_anchor=None,  # bbox that the legend will be anchored.
-                 bbox_transform=None,  # transform for the bbox
-                 frameon=None,  # draw frame
-                 handler_map=None,
-                 title_fontproperties=None,  # properties for the legend title
-                 ):
+    def __init__(
+        self, parent, handles, labels,
+        loc=None,
+        numpoints=None,      # number of points in the legend line
+        markerscale=None,    # relative size of legend markers vs. original
+        markerfirst=True,    # left/right ordering of legend marker and label
+        scatterpoints=None,  # number of scatter points
+        scatteryoffsets=None,
+        prop=None,           # properties for the legend texts
+        fontsize=None,       # keyword to set font size directly
+        labelcolor=None,     # keyword to set the text color
+
+        # spacing & pad defined as a fraction of the font-size
+        borderpad=None,      # whitespace inside the legend border
+        labelspacing=None,   # vertical space between the legend entries
+        handlelength=None,   # length of the legend handles
+        handleheight=None,   # height of the legend handles
+        handletextpad=None,  # pad between the legend handle and text
+        borderaxespad=None,  # pad between the axes and legend border
+        columnspacing=None,  # spacing between columns
+
+        ncol=1,     # number of columns
+        mode=None,  # horizontal distribution of columns: None or "expand"
+
+        fancybox=None,  # True: fancy box, False: rounded box, None: rcParam
+        shadow=None,
+        title=None,           # legend title
+        title_fontsize=None,  # legend title font size
+        framealpha=None,      # set frame alpha
+        edgecolor=None,       # frame patch edgecolor
+        facecolor=None,       # frame patch facecolor
+
+        bbox_to_anchor=None,  # bbox to which the legend will be anchored
+        bbox_transform=None,  # transform for the bbox
+        frameon=None,         # draw frame
+        handler_map=None,
+        title_fontproperties=None,  # properties for the legend title
+    ):
         """
         Parameters
         ----------
