Skip to content

DOC: clarify that display space coordinates are not stable #18178

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 1 commit into from
Aug 5, 2020

Conversation

tacaswell
Copy link
Member

PR Summary

  • add an inline comment above the transform call
  • promote the note to a warning

Hopefully this will prevent the confusion in #18170 and #18166 in the future.

- add an inline comment above the transform call
- promote the note to a warning
@jklymak
Copy link
Member

jklymak commented Aug 5, 2020

@Mike-HubGit would this have helped?

@Mike-HubGit
Copy link

for users like me I am not sure : in my mind a code example is far more striking than a comment somewhere. It is perhaps only my own preference, but what would have helped me would be a 3rd annotation using for example axes fraction coordinates (like in the suggestions I sent, but not to replace the "display" coordinates). This is for a single reason : a user of the library works in a more global code. If he has an example he will copy/paste it simply, and use what works for him, even if he doesn't have the knowledge of the underlying concepts of Matplotlib. And yes above this a comment that says that this is the most stable way to work.

This is perhaps only my way of thinking but : Matplotlib users are, I think, for most of them, general purpose scientists and not computer-science specialists. In their learning curve, the first code they want to use is a code that simply works. In a second step, if required, they will investigate better what'ss inside Matplotlib.

@jklymak
Copy link
Member

jklymak commented Aug 5, 2020

Thanks @Mike-HubGit. I think its important to bear in mind that the tutorials are longer form narratives and need some freedom to tell their own story versus provide self-contained examples.

@jklymak jklymak merged commit 52761de into matplotlib:master Aug 5, 2020
@tacaswell tacaswell deleted the doc_clarify_transforms branch May 6, 2021 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants