Skip to content

Commit 443e26b

Browse files
committed
doc update
1 parent 154f573 commit 443e26b

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

README.rst

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ IPython.
1616

1717
The big change from previous versions of ``ipy.vim`` is that it no longer
1818
requires the old brittle ``ipy_vimserver.py`` instantiation, and since
19-
it uses just vim and python, it is platform independent (i.e. should work
19+
it uses just vim and python, it is platform independent (i.e. works
2020
even on windows, unlike the previous \*nix only solution). The requirements
2121
are IPython 0.11+ with zeromq capabilities, vim compiled with +python.
2222

@@ -45,15 +45,28 @@ and for IPython 0.12, like this::
4545
:IPython --existing kernel-85997.json
4646

4747
The ``:IPythonClipboard`` command just uses the ``+`` register to get the
48-
connection string, whereas ``:IPythonXSelection`` uses the ``*`` register
48+
connection string, whereas ``:IPythonXSelection`` uses the ``*`` register.
49+
50+
**NEW in IPython 0.12**!
51+
Since IPython 0.12, you can simply use::
52+
53+
:IPython
54+
55+
without arguments to connect to the most recent IPython session (this is the
56+
same as passing just the ``--existing`` flag to ``ipython qtconsole`` and
57+
``ipython console``.
4958

5059
.. [*] Though the demos above use ``qtconsole``, it is not required
5160
for this workflow, it's just that it was the easiest way to show how to
52-
make use of the new functionality in 0.11 release. In the current git
53-
trunk of IPython, you can use ``ipython kernel`` to create a kernel and
54-
get the connection string to use for any frontend (including vim-ipython).
55-
If you are still using 0.11, you can launch a regular kernel using
56-
``python -c "from IPython.zmq.ipkernel import main; main()"``
61+
make use of the new functionality in 0.11 release. Since IPython 0.12, you
62+
can use ``ipython kernel`` to create a kernel and get the connection
63+
string to use for any frontend (including vim-ipython), or use ``ipython
64+
console`` to create a kernel and immediately connect to it using a
65+
terminal-based client. You can even connect to an active IPython Notebook
66+
kernel - just watch for the connection string that gets printed when you
67+
open the notebook, or use the ``%connect_info`` magic to get the
68+
connection string. If you are still using 0.11, you can launch a regular
69+
kernel using ``python -c "from IPython.zmq.ipkernel import main; main()"``
5770
5871
------------------------
5972
Sending lines to IPython
@@ -87,12 +100,17 @@ Then, go to the qtconsole and run this line::
87100

88101
You can also send whole files to IPython's ``%run`` magic using ``<F5>``.
89102

103+
**NEW in IPython 0.12**!
104+
If you're trying to do run code fragments that have leading whitespace, use
105+
``<Alt-S>`` instead - it will dedent a single line, and remove the leading
106+
whitespace of the first line from all lines in a visual mode selection.
107+
90108
-------------------------------
91109
IPython's object? Functionality
92110
-------------------------------
93111

94-
If you're using gvim, mouse-over a variable to see IPython's ? equivalent. If
95-
you're using vim from a terminal, or want to copy something from the
112+
If you're using gvim, mouse-over a variable to see IPython's ``?`` equivalent.
113+
If you're using vim from a terminal, or want to copy something from the
96114
docstring, type ``<leader>d``. ``<leader>`` is usually ``\`` (the backslash
97115
key). This will open a quickpreview window, which can be closed by hitting
98116
``q`` or ``<escape>``.
@@ -180,10 +198,15 @@ Current issues:
180198
Thanks and Bug Participation
181199
----------------------------
182200
* @MinRK for guiding me through the IPython kernel manager protocol.
183-
* @nakamuray and @tcheneau for reporting and providing a fix for when vim is compiled without a gui (#1)
184-
* @unpingco for reporting Windows bugs (#3,#4)
201+
* @nakamuray and @tcheneau for reporting and providing a fix for when vim is
202+
compiled without a gui (#1)
203+
* @unpingco for reporting Windows bugs (#3,#4), providing better multiline
204+
dedenting (#15), and suggesting that a resized vim-ipython shell stays
205+
resized (#16).
185206
* @simon-b for terminal vim arrow key issue (#5)
186-
* @jorgesca and @kwgoodman for shell (#6)
207+
* @jorgesca and @kwgoodman for shell update problems (#6)
187208
* @zeekay for easily allowing custom mappings (#9)
188209
* @minrk for support of connection_file-based IPython connection (#13)
189210
* @jorgesca for reporting the lack of profile handling capability (#14)
211+
* @enzbang for removing mapping that's not currently functional (#17)
212+
* @ogrisel for fixing documentation typo (#19)

0 commit comments

Comments
 (0)