Skip to content

Update docs on .inputrc and input mode. - #9497

Merged
takluyver merged 4 commits into
ipython:masterfrom
Carreau:inputrc-doc
May 27, 2016
Merged

takluyver merged 4 commits into
ipython:masterfrom
Carreau:inputrc-doc

Conversation

@Carreau

@Carreau Carreau commented May 25, 2016

Copy link
Copy Markdown
Member

Bump #9388 to 6.0

@Carreau Carreau added this to the 5.0 milestone May 25, 2016
Comment thread docs/source/interactive/reference.rst Outdated
file your :envvar:`INPUTRC` environment variable points to).

In particular if you want to change the input mode to ``vi``, you will need to
set the ``TerminalInteractiveShell.vi_mode`` configuration option of IPython.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I believe this was renamed to editing_mode.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good point.

Comment thread docs/source/interactive/reference.rst Outdated
during edition.

This feature does not use the ``readline`` library anymore – at least for now
– , so it will not honor your :file:`~/.inputrc` configuration (or whatever

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The 'at least for now' currently implies that it might rely on readline again in the future, whereas I guess you mean that it might respect inputrc again in the future.

As on #9388, I don't think we should try to support .inputrc at all - an imperfect emulation of readline's config is going to be more confusing than separating ourselves from it entirely. So I think we should just document that it's not supported, and not hint that maybe one day it will be.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Removed.

Comment thread docs/source/interactive/reference.rst Outdated

You will find the default values in your configuration file.

Starting with 5.0, IPython user `prompt_toolkit` in place of ``readline``,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

s/user/uses/

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

r and s are so close on french keyboards.

@takluyver
takluyver merged commit 8247911 into ipython:master May 27, 2016
@Carreau
Carreau deleted the inputrc-doc branch May 7, 2017 05:20
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.

3 participants