Skip to content

Dedupe docs of GridSpec.subplots. #19024

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

Merged
merged 1 commit into from
Nov 26, 2020
Merged

Dedupe docs of GridSpec.subplots. #19024

merged 1 commit into from
Nov 26, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 26, 2020

GridSpec.subplots, while user-facing, is relatively more low-level
than Figure.subplots, so it doesn't seem worth duplicating the
docstring in both places (I'm fine having it duplicated both in
pyplot.subplots and Figure.subplots are both are very much
user-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 of pyplot.subplots,
though).

Also note that a specific check a bit further down can go away once a
deprecation elapses.

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

`GridSpec.subplots`, while user-facing, is relatively more low-level
than `Figure.subplots`, so it doesn't seem worth duplicating the
docstring in both places (I'm fine having it duplicated both in
`pyplot.subplots` and `Figure.subplots` are both are very much
user-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 of `pyplot.subplots`,
though).

Also note that a specific check a bit further down can go away once a
deprecation elapses.
@jklymak jklymak merged commit 7e59e29 into matplotlib:master Nov 26, 2020
@anntzer anntzer deleted the gsd branch November 26, 2020 19:29
@QuLogic QuLogic added this to the v3.4.0 milestone Nov 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants