Skip to content
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

[Doc]: quiver ‘scale_units’ description is not very not clear #28209

Open
ahmedshaaban1 opened this issue May 11, 2024 · 4 comments
Open

Comments

@ahmedshaaban1
Copy link

Documentation Link

https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html

Problem

All,
Some of the matplotlib.pyplot.quiver plot arguments are vague ( based on the questions posted on StackOverflow). I think that the description of the ’scale_units’ could be clarified by:

Suggested improvement

  1. What scale is used here "If scale_units is 'x' then the vector will be 0.5 x-axis units”, is it 2 ? .
  2. Describing in detail the meaning of the "If the scale kwarg is None, the arrow length unit"
  3. The concept of the “unit” could be easily misunderstood, especially when dealing with physical parameters that have specific units.

Thanks

@ahmedshaaban1 ahmedshaaban1 changed the title [Doc]: quiver ‘scale_units’ documentation not very not clear [Doc]: quiver ‘scale_units’ description is not very not clear May 11, 2024
@hjhzdbssmsbrj
Copy link

I personally understand that for the scale=None scene, the library will automatically determine the scaling factor to ensure that the vector has visibility and appropriate size within the drawing area. Automatic scaling takes into account the dynamic range of vector amplitude and drawing dimensions to achieve a balance between clarity and information density. When the ideal visual representation is not immediately clear, this is a convenient feature that allows users to focus on the data without manually adjusting the scale from the beginning.

@Kaustbh
Copy link

Kaustbh commented Jun 1, 2024

Hi, can I work on it?

@hjhzdbssmsbrj
Copy link

hjhzdbssmsbrj commented Jun 1, 2024 via email

@tacaswell
Copy link
Member

We do not assign issues and you do not need permission to work on an issue.

I suspect that a majority of the work here will be to read the code and try out different input to be sure that the docs are correct. There may be enough complexity in this that it is worth writing up an analog to https://matplotlib.org/stable/users/explain/artists/imshow_extent.html for quiver.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants