Remove ipythonrc references from documentation #664
Conversation
| ipythonrc file, IPython's internal default is to do a case sensitive | ||
| search. | ||
| these options are given, the default is read from your configuration | ||
| file, with the option name 'wildcards_case_sensitive'. If this option |
There was a problem hiding this comment.
We should probably give the full option name, like InteractiveShell.wildcards_case_sensitive, assuming it still exists.
There was a problem hiding this comment.
I thought about that, but the problem is that it's different depending on which configuration file you're looking at - that is, in ipython_config.py it's TerminalInteractiveShell.wildcards_case_sensitive but in ipython_qtconsole_config.py it's ZMQInteractiveShell.wildcards_case_sensitive ... I could put both, but that seems a bit overly verbose. Alternatively, it could be (ShellClassName).wildcards_case_sensitive or something like that?
There was a problem hiding this comment.
I think they're both inheriting it from InteractiveShell, so changing it for InteractiveShell should change it for each subclass. The question of configuring them separately can probably be left for the config section.
There was a problem hiding this comment.
The changes I just committed (eteq/ipython@25f147e) address this and adjust similar places to reference more precisely what class the option belongs to. Thanks for the suggestion!
… as well as the option itself
|
@takluyver, I'll leave this one to you since you've already started working on it. Is it ready to merge? I'm just trying to flush the queue a little before euroscipy... |
| @@ -696,8 +697,7 @@ Even object attributes can be expanded:: | |||
| System command aliases | |||
| ---------------------- | |||
|
|
|||
| The %alias magic function and the alias option in the ipythonrc | |||
| configuration file allow you to define magic functions which are in fact | |||
| The %alias magic functionallows you to define magic functions which are in fact | |||
There was a problem hiding this comment.
"functionallows" --> "function allows"
|
Just spotted a few more things. Also, I think we can lose the last section of docs/source/interactive/tips.txt (which is already commented out). If someone wants to update it, I think it's a better fit for the cookbook. |
…nfiguration file option for TerminalInteractiveShell.editor
|
All 3 items should now be fixed. One other thing that seems odd (although probably not for this pull request): despite the editor magic being present in ZMQInteractiveShell, there seems to be no editor variable associated with ZMQInteractiveShell (it's defined in TerminalInteractiveShell rather than InteractiveShell). I'm not sure if this is a problem as I haven't looked at the edit magic internals, but it seems a bit strange... |
|
That's deliberate. The editor option is intended to be a terminal editor like vi or nano. It works a bit differently with ZMQ - it just sends the code to the frontend for editing. For the Qt console, there's an |
|
Thanks, @eteq - I've merged this in now. |
This pull request should remove all references to the old-style ipythonrc from the ipython documentation and docstrings (except where it is intentionally referring to an old version).
Note that I've left everything in quarantine and deathrow untouched, as well as docs/source/config/old.txt .
There was one reference to setting aliases in ipythonrc that I simply deleted, as the new ipython_config.py file does not seem to mention aliases. If there's some way of adding aliases that isn't in the default ipython_config.py, I can easily add that in.