Skip to content

DOC: fix an overlooked docs change from #19153 #19433

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

DOC: fix an overlooked docs change from #19153 #19433

wants to merge 1 commit into from

Conversation

lpsinger
Copy link
Contributor

@lpsinger lpsinger commented Feb 2, 2021

PR Summary

Fix an overlooked docs change from #19153, noted by @dstansby in #19432.

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).

@lpsinger lpsinger mentioned this pull request Feb 2, 2021
Closed
dstansby
dstansby requested changes Feb 2, 2021
View reviewed changes
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't just get rid of these docs without deprecating the behaviour it documents (if indeed we do want to change the behaviour, which I'm not sure we do in this case), in particular

Meanwhile, if you do not want this behavior (i.e., you want to force the creation of a new subplot), you must use a unique set of args and kwargs.

@astrofrog
Copy link
Contributor

I'm very concerned about this change, even if it was to go through a deprecation phase. As indicated in #19432 I don't understand why one would ever want the same axes to be returned if the projection and kwargs are different?

@dstansby dstansby added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Feb 2, 2021
@dstansby
Copy link
Member

dstansby commented Feb 2, 2021

I don't think I can dismiss my review, but if another maintainer wants to then go ahead. Apologies for jumping the gun on lots of this discussion, that has clearly been discussed more thoroughly on a dev call. I've tagged this as release critical so we don't forget it either way.

@tacaswell tacaswell added this to the v3.4.0 milestone Feb 2, 2021
@lpsinger
Copy link
Contributor Author

Closing in favor of #19438.

@lpsinger lpsinger closed this Feb 17, 2021
@lpsinger lpsinger deleted the pr19153-docs-cleanup branch February 19, 2021 01:08
@QuLogic QuLogic removed this from the v3.4.0 milestone Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dstansby dstansby dstansby requested changes

Assignees
No one assigned
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@lpsinger @astrofrog @dstansby @tacaswell @QuLogic