FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[Doc]: bad rendering of matplotlib.pyplot.quiver docs · Issue #31235 · matplotlib/matplotlib · GitHub

Repository navigation

[Doc]: bad rendering of matplotlib.pyplot.quiver docs #31235

Closed

Description

Documentation Link

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

Problem

Suggested improvement

No response

Activity

  1. changed the title [-][Doc]: bad render of matplotlib.pyplot.quiver docs[/-] [+][Doc]: bad rendering of matplotlib.pyplot.quiver docs[/+] on Mar 4, 2026
  2. story645 commented on Mar 4, 2026

    Member

    Oh that looks like it accidentally ended up in an indent/code block, fix being deindent by a little:

    The rendered arrow length is given by
    length in x direction = $\\frac{u}{\\mathrm{scale}} \\mathrm{scale_unit}$
    length in y direction = $\\frac{v}{\\mathrm{scale}} \\mathrm{scale_unit}$

    Seperatly, I'd also add bullets.

  3. amishamehta99 commented on Mar 4, 2026

    Contributor

    @story645 Hi! I'd like to work on fixing this documentation rendering issue if it's still available.

  4. story645 commented on Mar 4, 2026

    Member

    @amishamehta99 go for it! The annoying part here is please just check your rendered docs fix the issue before marking your PR as ready to review. (Which you likely were already planning to do).

  5. FrimpsManu commented on Mar 6, 2026

    Hi! I’d like to work on fixing the documentation rendering issue if it’s still available.

  6. timhoffm commented on Mar 6, 2026

    Member

    @FrimpsManu Go for it.

  7. amishamehta99 commented on Mar 7, 2026

    Contributor

    @amishamehta99 go for it! The annoying part here is please just check your rendered docs fix the issue before marking your PR as ready to review. (Which you likely were already planning to do).

    Thanks! I've started working on this and open a PR soon @story645

  8. amishamehta99 commented on Mar 7, 2026

    Contributor

    Hi! I’d like to work on fixing the documentation rendering issue if it’s still available.

    Hi @FrimpsManu, I had started looking into this after @story645 suggested I go ahead. I'll open a PR shortly.

    I couldn't respond earlier to confirm, so I just wanted to mention that I had already begun working on it.

  9. FrimpsManu commented on Mar 7, 2026

    Hi @amishamehta99 , thanks for letting me know

  10. amishamehta99 commented on Mar 9, 2026

    Contributor

    Oh that looks like it accidentally ended up in an indent/code block, fix being deindent by a little:

    matplotlib/lib/matplotlib/quiver.py

    Lines 144 to 148 in 726af38

     The rendered arrow length is given by 
    
         length in x direction = $\\frac{u}{\\mathrm{scale}} \\mathrm{scale_unit}$ 
    
         length in y direction = $\\frac{v}{\\mathrm{scale}} \\mathrm{scale_unit}$ 
    

    Seperatly, I'd also add bullets.

    Hi @story645,

    I opened PR #31252 to address this issue and have updated the rendering based on the earlier feedback. I verified the documentation through the CI-built docs, and it now shows:

    length in x direction = (u / scale) * scale_units
    length in y direction = (v / scale) * scale_units

    Before making any further changes, I just wanted to confirm whether this is the expected rendered format according to this issue.
    If anything still needs adjustment, I’d be happy to update it. Thank you!

  11. added this to the v3.11.0 milestone on Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions


      Back | FazBrowse Home | New Git URL