Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 9e0be95

Browse filesBrowse files
committed
Merge pull request #2442 from pelson/legend_tidy
Rewrite of the entire legend documentation, including tidy ups of code and style to all things "legend".
2 parents 1822356 + 59e7d13 commit 9e0be95
Copy full SHA for 9e0be95
Expand file treeCollapse file tree

30 files changed

+811
-915
lines changed

‎doc/api/api_changes.rst

Copy file name to clipboardExpand all lines: doc/api/api_changes.rst
+11Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,17 @@ original location:
7474
thus `colorbar.ColorbarBase.outline` is now a
7575
`matplotlib.patches.Polygon` object.
7676

77+
* The legend handler interface has changed from a callable, to any object
78+
which implements the ``legend_artists`` method (a deprecation phase will
79+
see this interface be maintained for v1.4). See
80+
:ref:`plotting-guide-legend` for further details. Further legend changes
81+
include:
82+
83+
* :func:`matplotlib.axes.Axes._get_legend_handles` now returns a generator
84+
of handles, rather than a list.
85+
86+
* The :func:`~matplotlib.pyplot.legend` function's "loc" positional
87+
argument has been deprecated. Use the "loc" keyword instead.
7788

7889
* The rcParams `savefig.transparent` has been added to control
7990
default transparency when saving figures.

‎doc/api/axes_api.rst

Copy file name to clipboardExpand all lines: doc/api/axes_api.rst
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ axes
99
.. autoclass:: matplotlib.axes.Axes
1010
:members:
1111
:undoc-members:
12-

‎doc/api/legend_api.rst

Copy file name to clipboardExpand all lines: doc/api/legend_api.rst
+7-1Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
******
2-
legend
2+
Legend
33
******
44

55

@@ -10,3 +10,9 @@ legend
1010
:members:
1111
:undoc-members:
1212
:show-inheritance:
13+
14+
:mod:`matplotlib.legend_handler`
15+
================================
16+
.. automodule:: matplotlib.legend_handler
17+
:members:
18+
:undoc-members:

‎doc/api/matplotlib_configuration_api.rst

Copy file name to clipboardExpand all lines: doc/api/matplotlib_configuration_api.rst
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ The top level :mod:`matplotlib` module
66
77
.. autofunction:: use
88

9-
.. autofunction:: get_backend
9+
.. autofunction:: get_backend
1010

11-
.. py:data:: matplotlib.rcParams
11+
.. py:data:: rcParams
1212
1313
An instance of :class:`RcParams` for handling default matplotlib values.
1414

‎doc/api/offsetbox.rst

Copy file name to clipboard
+12Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*********
2+
offsetbox
3+
*********
4+
5+
6+
:mod:`matplotlib.offsetbox`
7+
===========================
8+
9+
.. automodule:: matplotlib.offsetbox
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.