Make most params to figure()/Figure() kwonly.

anntzer · anntzer · commit b5252b497ad5 · 2022-02-07T09:12:06.000+01:00
This will allow tweaking the displayed signature of figure(), e.g.
hiding `facecolor` and `edgecolor` (likely rarely used) into `kwargs`
while making e.g. `layout` more prominent.
diff --git a/doc/api/next_api_changes/deprecations/22421-AL.rst b/doc/api/next_api_changes/deprecations/22421-AL.rst
@@ -0,0 +1,5 @@
+Parameters to ``plt.figure()`` and the ``Figure`` constructor
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+All parameters to `.pyplot.figure` and the `.Figure` constructor, other than
+*num*, *figsize*, and *dpi*, will become keyword-only after a deprecation
+period.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2129,6 +2129,7 @@ def __repr__(self):
             naxes=len(self.axes),
         )
 
+    @_api.make_keyword_only("3.6", "facecolor")
     def __init__(self,
                  figsize=None,
                  dpi=None,
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -667,6 +667,7 @@ def __exit__(self, *args):
 
 ## Figures ##
 
+@_api.make_keyword_only("3.6", "facecolor")
 def figure(num=None,  # autoincrement if None, else integer from 1-N
            figsize=None,  # defaults to rc figure.figsize
            dpi=None,  # defaults to rc figure.dpi

Original file line number	Diff line number	Diff line change
`@@ -2129,6 +2129,7 @@ def __repr__(self):`
`2129`	`2129`	`naxes=len(self.axes),`
`2130`	`2130`	`)`
`2131`	`2131`
	`2132`	`+ @_api.make_keyword_only("3.6", "facecolor")`
`2132`	`2133`	`def __init__(self,`
`2133`	`2134`	`figsize=None,`
`2134`	`2135`	`dpi=None,`