DOC: Tweaks to module API pages #20319
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This fixes some minor typos on module pages, and some tweaks to callouts and inheritance diagrams.
Strong recommendations at the top of module are now
.. important
, less strong are now.. note
. I dropped extra classes from the date and transform inheritance diagrams. I'm not sure ifArtist
should hide_AnnotationBase
andScalaraMappable
as well?I also noted that the table is lightly maintained and that blume may be preferable, but I'm not sure if we should just point at the third-party page in general?
PR Checklist
pytest
passes).flake8
on changed files to check).flake8-docstrings
and runflake8 --docstring-convention=all
).doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).