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
Add links and expand mathmpl docstring #25221
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub needs a more active status than 'leave a comment' which is kinda passive aggressive...or a fine tuned what is the blocking request.
Most of these are flow suggestions and the rest are changes to language that was already there but I figure should be changed to achieve the aims of this PR but I can open the PR if out of scope.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't even know if I'm being nitpicky here. Can take or leave my comments, just let me know so I can merge either way.
Thanks for the comments - they do help! Don't forget also I'm not a native speaker so rewording suggestions are always welcome 😄 |
doc/devel/documenting_mpl.rst
Outdated
|
||
In most cases, you will likely want to use one of `Sphinx's builtin Math | ||
extensions <https://www.sphinx-doc.org/en/master/usage/extensions/math.html>`__. | ||
In rare cases we want the rendering of the mathematical text in the documentation html to exactly match with the rendering of the mathematical expression in the Matplotlib figure. In these cases, you can use the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should wrap.
Co-authored-by: hannah <story645@gmail.com>
Thanks @QuLogic - I think I got everything and also rebased just in case. |
Not sure why the errors didn't post:
|
I think that did it! |
PR Summary
This PR clarifies the purpose and recommended uses for mathmpl and adds links to the relevant information in the tutorial and "Writing documentation" pages.
PR Checklist
Documentation and Tests
pytest
passes)Release Notes
.. versionadded::
directive in the docstring and documented indoc/users/next_whats_new/
.. versionchanged::
directive in the docstring and documented indoc/api/next_api_changes/
next_whats_new/README.rst
ornext_api_changes/README.rst