Skip to content

Clarify docstring of [un]install_repl_displayhook() #22911

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
Apr 28, 2022

Conversation

timhoffm
Copy link
Member

Still not clear to me: Does this have to be a public function? When
would a user call it explicitly?

@@ -153,7 +156,7 @@ def post_execute():

def uninstall_repl_displayhook():
"""
Uninstall the Matplotlib display hook.
Disconnect from the display hook of the current shell.

.. warning::
Copy link
Contributor

Choose a reason for hiding this comment

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

While you are here, you can remove this warning entirely, I think: this system does not actually interact with sys.displayhook ever since #4506.

Copy link
Member Author

Choose a reason for hiding this comment

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

done.

@timhoffm timhoffm force-pushed the doc-repl-displayhook branch from dc0ca60 to 618ecc9 Compare April 27, 2022 21:49
Still not clear to me: Does this have to be a public function? When
would a user call it explicitly?
@timhoffm timhoffm force-pushed the doc-repl-displayhook branch from 618ecc9 to 83701e9 Compare April 27, 2022 21:51
@anntzer
Copy link
Contributor

anntzer commented Apr 27, 2022

I think it's worth letting @tacaswell have a look before merging, as he's probably the most knowledgeable on this topic.

@tacaswell
Copy link
Member

It is fun that we have both displayhook and inputhook 👍🏻

@tacaswell tacaswell merged commit e779b97 into matplotlib:main Apr 28, 2022
@timhoffm timhoffm deleted the doc-repl-displayhook branch April 28, 2022 05:16
@oscargus oscargus added this to the v3.6.0 milestone Aug 1, 2022
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.

4 participants