Skip to content
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

Documentation of "Terminal IPython options" encourages users to do the wrong thing #12325

Open
eric-wieser opened this issue May 21, 2020 · 0 comments

Comments

@eric-wieser
Copy link
Contributor

This documentation page contains entries like:

image

This seems to encourage users to set the properties as:

from IPython.core.interactiveshell import InteractiveShell
InteractiveShell.ast_node_interactivity = "all"

whereas I think the intended use is:

get_ipython().ast_node_interactivity = 'all'

Three questions then:

  • Is my interpretation of the way to apply these settings correct?
  • Can you think of a way to improve the documentation so users don't do this?
  • Should the metaclass of InteractiveShell throw an exception if someone tries to do this?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant