Hi @amishamehta99 thank you for your contribution. I’m going to put this in draft for now while you fix the linting and doc-build failures. The easiest way to check the linting locally is to install the pre-commit hooks.
https://matplotlib.org/devdocs/devel/development_setup.html#pre-commit-hooks

You can also build the docs locally to ensure that the build succeeds and renders how you intend.
https://matplotlib.org/devdocs/devel/document.html#build-docs

Please mark this as "ready for review" when you are ready. In the meantime, if you need help, feel free to ask questions here. Or you may prefer to ask them in our incubator chat room for new contributors.

Hi @amishamehta99 thank you for your contribution. I’m going to put this in draft for now while you fix the linting and doc-build failures. The easiest way to check the linting locally is to install the pre-commit hooks. https://matplotlib.org/devdocs/devel/development_setup.html#pre-commit-hooks

You can also build the docs locally to ensure that the build succeeds and renders how you intend. https://matplotlib.org/devdocs/devel/document.html#build-docs

Please mark this as "ready for review" when you are ready. In the meantime, if you need help, feel free to ask questions here. Or you may prefer to ask them in our incubator chat room for new contributors.

Hi @rcomer, thanks for the guidance. I’ve installed the pre-commit hooks, applied the fixes, and marked the PR ready for review. The CI checks are currently running again. Please let me know if any further changes are needed.

@amishamehta99 you haven’t pushed anything. Please check that the documentation renders as expected before asking for review again. I note that you were asked to do that four days ago #31235 (comment)

@amishamehta99 you haven’t pushed anything. Please check that the documentation renders as expected before asking for review again. I note that you were asked to do that four days ago #31235 (comment)

Hi!Thanks for reminding me. Also, due to some glitch the changes werent pushed, apologies. The CI failure appears to be a 'test_webagg' timeout. Since this PR only updates a docstring, it seems unrelated. I have made the required changes. Could someone with permissions please rerun the CI jobs?Suggest changes, if any. Thank you!

The webagg timeout is indeed flaky and can be ignored.

The rendered docs for quiver still look wrong. Note you can navigate to this yourself by following the “View the built docs” link in the checks below. You can also build the docs and inspect them locally as I already mentioned above.
https://output.circle-artifacts.com/output/job/3f9b946e-a944-462c-836b-bfdfb4fe3a03/artifacts/0/doc/build/html/api/_as_gen/matplotlib.axes.Axes.quiver.html#matplotlib.axes.Axes.quiver

@amishamehta99 you have already been asked twice to check the rendering yourself before asking for review. It is not a good use of maintainers’ time to repeatedly point out problems that you could have checked yourself. Please do not ask for feedback again unless you have verified that the rendering is correct. If you do not know how to fix the rendering, then that is fine: you can close the PR and someone else can work on the problem.

The webagg timeout is indeed flaky and can be ignored.

The rendered docs for quiver still look wrong. Note you can navigate to this yourself by following the “View the built docs” link in the checks below. You can also build the docs and inspect them locally as I already mentioned above. https://output.circle-artifacts.com/output/job/3f9b946e-a944-462c-836b-bfdfb4fe3a03/artifacts/0/doc/build/html/api/_as_gen/matplotlib.axes.Axes.quiver.html#matplotlib.axes.Axes.quiver

@amishamehta99 you have already been asked twice to check the rendering yourself before asking for review. It is not a good use of maintainers’ time to repeatedly point out problems that you could have checked yourself. Please do not ask for feedback again unless you have verified that the rendering is correct. If you do not know how to fix the rendering, then that is fine: you can close the PR and someone else can work on the problem.

I verified the rendered documentation from the CI artifacts and the formulas now render correctly. Could you please check it out and suggest changes, if any.

this is what it looks like to me:

https://output.circle-artifacts.com/output/job/8a73a996-7226-4b56-ba8a-71dee664e77e/artifacts/0/doc/build/html/api/_as_gen/matplotlib.axes.Axes.quiver.html#matplotlib.axes.Axes.quiver

probably b/c the docs are currently indented to the same level as the parameters rather than the descriptions.

Also we build the docs as part of the ci, click on it and you can see 'em too:

Also we build the docs as part of the ci, click on it and you can see 'em too:

Hi @story645, thanks for the suggestion. I have tried to adjust the indentation.
However, in the rendered docs the two formula lines appear on the same line.
Should these be formatted as a literal block (using ::) to preserve line breaks?Asking this query before pushing the code.

I'd just make em bullets

Thanks! I updated the equations to bullet points and verified that the rendered documentation now displays them correctly. Is it correct?

The whole point of this PR was to clean up the indent so the math formatting would render and you took away the math formatting (sorry I didn't catch that earlier) and bullets are supposed to be slightly indented under they're jntro. Thank you for your effort but I'm concerned at how many review cycles this is taking for fixing formatting.

Sorry I was wrong about the slight indent (for bullets) :/

Please tell reviewers if they give you instructions that don't work and fix the mistake! This is what the final formatting is supposed to look like

Sorry I was wrong about the slight indent (for bullets) :/

Please tell reviewers if they give you instructions that don't work and fix the mistake! This is what the final formatting is supposed to look like

Thanks for finishing this out, please take more care understanding the problem and solution on your next pr.

Thank you for the review, feedback and trusting me with the fix!
I appreciate the guidance and will make sure to better understand the issue before submitting my next PR.