Skip to content

Clarify that it is ok to use plt.subplots to create figures #19554

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

Closed
wants to merge 1 commit into from
Closed

Clarify that it is ok to use plt.subplots to create figures #19554

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion tutorials/introductory/lifecycle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
.. note::

In general, try to use the object-oriented interface over the pyplot
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
In general, try to use the object-oriented interface over the pyplot
In general, the explicit interface is preferred over the pyplot

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That would require rephrasing the earlier paragraphs in the tutorial as well. That may be a good thing to do but wasn't my intention here. Is this enough of an incremental improvement to stand on its own?

Copy link
Member

Choose a reason for hiding this comment

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

explicit object-oriented..?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's better but it is still a break from how the opening paragraph describes things. But perhaps Im worrying too much about that

Copy link
Member

Choose a reason for hiding this comment

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

Maybe fix the first parapraph while we are here? It is not terribly clear.

interface.
interface for making the plots. However, for creating figures and axes
the pyplot interface with `~.pyplot.subplots` should be preferred.
Comment on lines +44 to +45
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
interface for making the plots. However, for creating figures and axes
the pyplot interface with `~.pyplot.subplots` should be preferred.
interface for making the plots. The `~.pyplot` module still has some useful
shortcuts, and in particular is the preferable method for instantiating figures
and axes via ``fig=plt.figure()`` or ``fig, axs=plt.subplots(2, 1)``.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like this.


Our data
========
Expand Down