Skip to content

DOC: Correct shading behavior descriptions in pcolor/pcolormesh #31731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lucaznch wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −10
Open

DOC: Correct shading behavior descriptions in pcolor/pcolormesh #31731

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eb0b51
DOC: Correct exception type for invalid X,Y shapes
lucaznch May 21, 2026
f5b6b89
DOC: Remove 'flat' shading deprecation note
lucaznch May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6617,11 +6617,11 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,
:ref:`Notes <axes-pcolormesh-grid-orientation>` section below.

If ``shading='flat'`` the dimensions of *X* and *Y* should be one
greater than those of *C*, otherwise a ValueError is raised. The
greater than those of *C*, otherwise a TypeError is raised. The
quadrilateral is colored due to the value at ``C[i, j]``.

If ``shading='nearest'``, the dimensions of *X* and *Y* should be
the same as those of *C* (if not, a ValueError will be raised). The
the same as those of *C* (if not, a TypeError will be raised). The
color ``C[i, j]`` will be centered on ``(X[i, j], Y[i, j])``.

If *X* and/or *Y* are 1-D arrays or column vectors they will be
Expand All @@ -6634,9 +6634,7 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,
- 'flat': A solid color is used for each quad. The color of the
quad (i, j), (i+1, j), (i, j+1), (i+1, j+1) is given by
``C[i, j]``. The dimensions of *X* and *Y* should be
one greater than those of *C*; if they are the same as *C*,
then a deprecation warning is raised, and the last row
and column of *C* are dropped.
one greater than those of *C*.
- 'nearest': Each grid point will have a color centered on it,
extending halfway between the adjacent grid centers. The
dimensions of *X* and *Y* must be the same as *C*.
Expand Down Expand Up @@ -6822,11 +6820,11 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
:ref:`Notes <axes-pcolormesh-grid-orientation>` section below.

If ``shading='flat'`` the dimensions of *X* and *Y* should be one
greater than those of *C*, otherwise a ValueError is raised. The
greater than those of *C*, otherwise a TypeError is raised. The
quadrilateral is colored due to the value at ``C[i, j]``.

If ``shading='nearest'`` or ``'gouraud'``, the dimensions of *X*
and *Y* should be the same as those of *C* (if not, a ValueError
and *Y* should be the same as those of *C* (if not, a TypeError
will be raised). For ``'nearest'`` the color ``C[i, j]`` is
centered on ``(X[i, j], Y[i, j])``. For ``'gouraud'``, a smooth
interpolation is carried out between the quadrilateral corners.
Expand Down Expand Up @@ -6864,9 +6862,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
- 'flat': A solid color is used for each quad. The color of the
quad (i, j), (i+1, j), (i, j+1), (i+1, j+1) is given by
``C[i, j]``. The dimensions of *X* and *Y* should be
one greater than those of *C*; if they are the same as *C*,
then a deprecation warning is raised, and the last row
and column of *C* are dropped.
one greater than those of *C*.
- 'nearest': Each grid point will have a color centered on it,
extending halfway between the adjacent grid centers. The
dimensions of *X* and *Y* must be the same as *C*.
Expand Down
Loading