Dedupe docs of GridSpec.subplots. #19024
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.
GridSpec.subplots
, while user-facing, is relatively more low-levelthan
Figure.subplots
, so it doesn't seem worth duplicating thedocstring in both places (I'm fine having it duplicated both in
pyplot.subplots
andFigure.subplots
are both are very muchuser-facing). Less duplication also means fewer chances to forget to
update the docs in all places, as was the case for the remark regarding
set_units
(which is already present in the docs ofpyplot.subplots
,though).
Also note that a specific check a bit further down can go away once a
deprecation elapses.
PR Summary
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).