Skip to content

Pcolormesh Doc Fix - #30912

Merged
timhoffm merged 5 commits into
matplotlib:mainfrom
sanrishi:pcolor-fix
Jan 2, 2026
Merged

Pcolormesh Doc Fix#30912
timhoffm merged 5 commits into
matplotlib:mainfrom
sanrishi:pcolor-fix

Conversation

@sanrishi

@sanrishi sanrishi commented Dec 30, 2025

Copy link
Copy Markdown
Contributor

PR summary

Summary

 Updates the documentation for the `snap` parameter in `pcolormesh` 
 to reflect that the default value is now `True` (changed in v3.4.0).

Changes

 - Updated parameter documentation from `default: False` to `default: True`
 - Added version changed note referencing the 3.4.0 release

Context

 The behavior was intentionally changed in #16090 to improve 
 transparency handling. Only the rcParam is temporary and will 
 be removed eventually.

PR checklist

@sanrishi

sanrishi commented Jan 1, 2026

Copy link
Copy Markdown
Contributor Author

@timhoffm is this alright now ?

@rcomer

rcomer commented Jan 1, 2026

Copy link
Copy Markdown
Member

@sanrishi please have a look yourself at how this renders in the built docs. You can do this by clicking "View the built docs" in the CI below, or by building the docs locally.

timhoffm
timhoffm reviewed Jan 1, 2026
View reviewed changes
Comment thread lib/matplotlib/axes/_axes.py Resolved
@sanrishi @timhoffm
Update lib/matplotlib/axes/_axes.py
95a5b3f 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@sanrishi

sanrishi commented Jan 1, 2026

Copy link
Copy Markdown
Contributor Author

@timhoffm @rcomer Thanks for guidance

@sanrishi

sanrishi commented Jan 2, 2026

Copy link
Copy Markdown
Contributor Author

@timhoffm I checked the rendered docs through the CI build. The :rc:pcolormesh.snap`` formatting renders correctly as a link to the rcParam. Everything looks good!
image

@timhoffm timhoffm added the Documentation: API files in lib/ and doc/api label Jan 2, 2026
@timhoffm
timhoffm merged commit b2dc2a6 into matplotlib:main Jan 2, 2026
40 of 41 checks passed
@rcomer rcomer added this to the v3.11.0 milestone Jan 2, 2026
@sanrishi
sanrishi deleted the pcolor-fix branch January 23, 2026 17:43
andreas16700 added a commit to andreas16700/matplotlib that referenced this pull request Jan 30, 2026
@andreas16700 @claude
Run 80: Match upstream b2dc2a6 (PR matplotlib#30912) - Pcolormesh Doc…
87ee51f 
… Fix

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Documentation: API files in lib/ and doc/api

Projects

None yet

Milestone

v3.11.0

Development

Successfully merging this pull request may close these issues.

[Bug]: Mismatch in documented default behaviour of pcolormesh 'snap'

3 participants

@sanrishi @rcomer @timhoffm