Skip to content

DOC: Improve NonUniformImage docs #29370

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.

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

Merged
merged 2 commits into from
Apr 29, 2025

Conversation

timhoffm
Copy link
Member

No description provided.

@github-actions github-actions bot added topic: images Documentation: examples files in galleries/examples labels Dec 21, 2024
@timhoffm timhoffm force-pushed the doc-nonuniformimage branch 2 times, most recently from 03517d0 to c6baa0b Compare December 21, 2024 16:44
@timhoffm timhoffm added this to the v3.10.1 milestone Dec 21, 2024
@jklymak
Copy link
Member

jklymak commented Dec 21, 2024

Please see the comment at #29368 (comment). I think we should go further and discourage its use to prevent a maintenance burden of a method that doesn't have much advantage.

@timhoffm timhoffm force-pushed the doc-nonuniformimage branch from c6baa0b to 1591005 Compare December 21, 2024 19:49
@timhoffm
Copy link
Member Author

Discouraging/deprecating is more than I want to invest into this PR. I just realized, that we have not documented what non-uniform actually means and added a quick description. IMHO that's a plus even if we decide to discrouage/deprecate.

Discouraging/deprecating needs a dedicated discussion. There are some things to consider:

@ksunden ksunden modified the milestones: v3.10.1, v3.10.2 Feb 21, 2025
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - one optional suggestion.

Co-authored-by: David Stansby <dstansby@gmail.com>
@timhoffm
Copy link
Member Author

@dstansby I've accepted your proposal. Please squash-merge.

@dstansby dstansby merged commit 033b666 into matplotlib:main Apr 29, 2025
40 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 29, 2025
@timhoffm timhoffm deleted the doc-nonuniformimage branch April 29, 2025 15:35
rcomer added a commit that referenced this pull request Apr 29, 2025
…370-on-v3.10.x

Backport PR #29370 on branch v3.10.x (DOC: Improve NonUniformImage docs)
@ksunden ksunden mentioned this pull request May 9, 2025
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: examples files in galleries/examples topic: images
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants