Merge branch 'matplotlib:main' into shuffleFix

Author: tybeller

.github/workflows/cibuildsdist.yml

@@ -62,3 +62,9 @@ jobs:
 
       - name: Check version number is not 0
         run: python ./ci/check_version_number.py
+
+      - name: Install twine
+        run: pip install twine
+
+      - name: Check README rendering for PyPI
+        run: twine check dist/*

README.md

@@ -0,0 +1,89 @@
+[![PyPi](https://badge.fury.io/py/matplotlib.svg)](https://badge.fury.io/py/matplotlib)
+[![Downloads](https://pepy.tech/badge/matplotlib/month)](https://pepy.tech/project/matplotlib)
+[![NUMFocus](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org)
+
+[![DiscourseBadge](https://img.shields.io/badge/help_forum-discourse-blue.svg)](https://discourse.matplotlib.org)
+[![Gitter](https://badges.gitter.im/matplotlib/matplotlib.svg)](https://gitter.im/matplotlib/matplotlib)
+[![GitHubIssues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/matplotlib/matplotlib/issues)
+[![GitTutorial](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project)
+
+[![GitHubActions](https://github.com/matplotlib/matplotlib/workflows/Tests/badge.svg)](https://github.com/matplotlib/matplotlib/actions?query=workflow%3ATests)
+[![AzurePipelines](https://dev.azure.com/matplotlib/matplotlib/_apis/build/status/matplotlib.matplotlib?branchName=main)](https://dev.azure.com/matplotlib/matplotlib/_build/latest?definitionId=1&branchName=main)
+[![AppVeyor](https://ci.appveyor.com/api/projects/status/github/matplotlib/matplotlib?branch=main&svg=true)](https://ci.appveyor.com/project/matplotlib/matplotlib)
+[![Codecov](https://codecov.io/github/matplotlib/matplotlib/badge.svg?branch=main&service=github)](https://codecov.io/github/matplotlib/matplotlib?branch=main)
+[![LGTM](https://img.shields.io/lgtm/grade/python/github/matplotlib/matplotlib.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/matplotlib/matplotlib)
+
+![image](https://matplotlib.org/_static/logo2.svg)
+
+Matplotlib is a comprehensive library for creating static, animated, and
+interactive visualizations in Python.
+
+Check out our [home page](https://matplotlib.org/) for more information.
+
+![image](https://matplotlib.org/_static/readme_preview.png)
+
+Matplotlib produces publication-quality figures in a variety of hardcopy
+formats and interactive environments across platforms. Matplotlib can be
+used in Python scripts, Python/IPython shells, web application servers,
+and various graphical user interface toolkits.
+
+## Install
+
+See the [install
+documentation](https://matplotlib.org/stable/users/installing/index.html),
+which is generated from `/doc/users/installing/index.rst`
+
+## Contribute
+
+You've discovered a bug or something else you want to change -
+excellent!
+
+You've worked out a way to fix it -- even better!
+
+You want to tell us about it -- best of all!
+
+Start at the [contributing
+guide](https://matplotlib.org/devdocs/devel/contributing.html)!
+
+## Contact
+
+[Discourse](https://discourse.matplotlib.org/) is the discussion forum
+for general questions and discussions and our recommended starting
+point.
+
+Our active mailing lists (which are mirrored on Discourse) are:
+
+-   [Users](https://mail.python.org/mailman/listinfo/matplotlib-users)
+    mailing list: <[email protected]>
+-   [Announcement](https://mail.python.org/mailman/listinfo/matplotlib-announce)
+    mailing list: <[email protected]>
+-   [Development](https://mail.python.org/mailman/listinfo/matplotlib-devel)
+    mailing list: <[email protected]>
+
+[Gitter](https://gitter.im/matplotlib/matplotlib) is for coordinating
+development and asking questions directly related to contributing to
+matplotlib.
+
+## Citing Matplotlib
+
+If Matplotlib contributes to a project that leads to publication, please
+acknowledge this by citing Matplotlib.
+
+[A ready-made citation
+entry](https://matplotlib.org/stable/users/project/citing.html) is
+available.
+
+### Research notice
+
+Please note that this repository is participating in a study into
+sustainability of open source projects. Data will be gathered about this
+repository for approximately the next 12 months, starting from June
+2021.
+
+Data collected will include number of contributors, number of PRs, time
+taken to close/merge these PRs, and issues closed.
+
+For more information, please visit [the informational
+page](https://sustainable-open-science-and-software.github.io/) or
+download the [participant information
+sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).

README.rst

@@ -0,0 +1,3 @@
+``axes3d.vvec``, ``axes3d.eye``, ``axes3d.sx``, and ``axes3d.sy``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... are deprecated without replacement.

doc/api/next_api_changes/deprecations/23449-SS.rst

@@ -0,0 +1,9 @@
+Colorbars for orphaned mappables are deprecated, but no longer raise
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Before 3.6.0, Colorbars for mappables that do not have a parent axes would
+steal space from the current Axes.  3.6.0 raised an error on this, but without
+a deprecation cycle.  For 3.6.1 this is reverted, the current axes is used,
+but a deprecation warning is shown instead.  In this undetermined case users
+and libraries should explicitly specify what axes they want space to be stolen
+from: ``fig.colorbar(mappable, ax=plt.gca())``.

doc/api/next_api_changes/deprecations/24088-JMK.rst

@@ -52,7 +52,12 @@ In Matplotlib 3.6 we have marked those top level functions as pending
 deprecation with the intention of deprecation in Matplotlib 3.7. The following
 functions have been marked for pending deprecation:
 
-- ``matplotlib.cm.get_cmap``; use ``matplotlib.colormaps[name]`` instead
+- ``matplotlib.cm.get_cmap``; use ``matplotlib.colormaps[name]`` instead if you
+  have a `str`.
+
+  **Added 3.6.1** Use `matplotlib.cm.ColormapRegistry.get_cmap` if you
+  have a string, `None` or a `matplotlib.colors.Colormap` object that you want
+  to convert to a `matplotlib.colors.Colormap` instance.
 - ``matplotlib.cm.register_cmap``; use `matplotlib.colormaps.register
   <.ColormapRegistry.register>` instead
 - ``matplotlib.cm.unregister_cmap``; use `matplotlib.colormaps.unregister
@@ -305,7 +310,7 @@ Backend-specific deprecations
   private functions if you rely on it.
 - ``backend_svg.generate_transform`` and ``backend_svg.generate_css``
 - ``backend_tk.NavigationToolbar2Tk.lastrect`` and
-  ``backend_tk.RubberbandTk.lastrect`` 
+  ``backend_tk.RubberbandTk.lastrect``
 - ``backend_tk.NavigationToolbar2Tk.window``; use ``toolbar.master`` instead.
 - ``backend_tools.ToolBase.destroy``; To run code upon tool removal, connect to
   the ``tool_removed_event`` event.

doc/api/prev_api_changes/api_changes_3.6.0/deprecations.rst

@@ -0,0 +1,8 @@
+3D plot pan and zoom buttons
+----------------------------
+
+The pan and zoom buttons in the toolbar of 3D plots are now enabled.
+Unselect both to rotate the plot. When the zoom button is pressed,
+zoom in by using the left mouse button to draw a bounding box, and
+out by using the right mouse button to draw the box. When zooming a
+3D plot, the current view aspect ratios are kept fixed.

doc/users/next_whats_new/3d_plot_pan_zoom.rst

@@ -0,0 +1,7 @@
+Fixed errorbars in polar plots
+------------------------------
+Caps and error lines are now drawn with respect to polar coordinates,
+when plotting errorbars on polar plots.
+
+.. figure:: /gallery/pie_and_polar_charts/images/sphx_glr_polar_error_caps_001.png
+   :target: ../../gallery/pie_and_polar_charts/polar_error_caps.html

doc/users/next_whats_new/polar_errorbar_caps.rst

@@ -0,0 +1,53 @@
+"""
+=================================
+Error bar rendering on polar axis
+=================================
+
+Demo of error bar plot in polar coordinates.
+Theta error bars are curved lines ended with caps oriented towards the
+center.
+Radius error bars are straight lines oriented towards center with
+perpendicular caps.
+"""
+import numpy as np
+import matplotlib.pyplot as plt
+
+theta = np.arange(0, 2 * np.pi, np.pi / 4)
+r = theta / np.pi / 2 + 0.5
+
+fig = plt.figure(figsize=(10, 10))
+ax = fig.add_subplot(projection='polar')
+ax.errorbar(theta, r, xerr=0.25, yerr=0.1, capsize=7, fmt="o", c="seagreen")
+ax.set_title("Pretty polar error bars")
+plt.show()
+
+#############################################################################
+# Please acknowledge that large theta error bars will be overlapping.
+# This may reduce readability of the output plot. See example figure below:
+
+fig = plt.figure(figsize=(10, 10))
+ax = fig.add_subplot(projection='polar')
+ax.errorbar(theta, r, xerr=5.25, yerr=0.1, capsize=7, fmt="o", c="darkred")
+ax.set_title("Overlapping theta error bars")
+plt.show()
+
+#############################################################################
+# On the other hand, large radius error bars will never overlap, they just
+# lead to unwanted scale in the data, reducing the displayed range.
+
+fig = plt.figure(figsize=(10, 10))
+ax = fig.add_subplot(projection='polar')
+ax.errorbar(theta, r, xerr=0.25, yerr=10.1, capsize=7, fmt="o", c="orangered")
+ax.set_title("Large radius error bars")
+plt.show()
+
+
+#############################################################################
+#
+# .. admonition:: References
+#
+#    The use of the following functions, methods, classes and modules is shown
+#    in this example:
+#
+#    - `matplotlib.axes.Axes.errorbar` / `matplotlib.pyplot.errorbar`
+#    - `matplotlib.projections.polar`

examples/pie_and_polar_charts/polar_error_caps.py

@@ -475,6 +475,14 @@ class UnicodeFonts(TruetypeFonts):
     symbol can not be found in the font.
     """
 
+    # Some glyphs are not present in the `cmr10` font, and must be brought in
+    # from `cmsy10`. Map the Unicode indices of those glyphs to the indices at
+    # which they are found in `cmsy10`.
+    _cmr10_substitutions = {
+        0x00D7: 0x00A3,  # Multiplication sign.
+        0x2212: 0x00A1,  # Minus sign.
+    }
+
     def __init__(self, *args, **kwargs):
         # This must come first so the backend's owner is set correctly
         fallback_rc = mpl.rcParams['mathtext.fallback']
@@ -541,11 +549,11 @@ def _get_glyph(self, fontname, font_class, sym):
             found_symbol = False
             font = self._get_font(new_fontname)
             if font is not None:
-                if font.family_name == "cmr10" and uniindex == 0x2212:
-                    # minus sign exists in cmsy10 (not cmr10)
+                if (uniindex in self._cmr10_substitutions
+                        and font.family_name == "cmr10"):
                     font = get_font(
                         cbook._get_data_path("fonts/ttf/cmsy10.ttf"))
-                    uniindex = 0xa1
+                    uniindex = self._cmr10_substitutions[uniindex]
                 glyphindex = font.get_char_index(uniindex)
                 if glyphindex != 0:
                     found_symbol = True