Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
williamjameshandley committed Oct 31, 2019
1 parent 142d865 commit 308f7f3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Vimteractive
============
:vimteractive: send commands from text files to interactive programs via vim
:Author: Will Handley
:Version: 2.0.2
:Version: 2.1.0
:Homepage: https://github.com/williamjameshandley/vimteractive
:Documentation: ``:help vimteractive``

Expand Down Expand Up @@ -156,8 +156,7 @@ cursor the terminal.
In Insert mode, ``CTRL-S`` sends the line currently being edited, and
then returns to insert mode at the same location.

In Visual mode, ``CTRL-S`` sends all currently selected lines to the
terminal.
In Visual mode, ``CTRL-S`` sends the current selection to the terminal.

``ALT-S`` sends all lines from the start to the current line.

Expand Down Expand Up @@ -219,6 +218,7 @@ Similar projects

Changelist
----------
:v2.1: `Visual selection improvement <https://github.com/williamjameshandley/vimteractive/pull/15>`__
:v2.0: `Multiple terminal functionality <https://github.com/williamjameshandley/vimteractive/pull/9>`__
:v1.7: `Autodetection of terminals <https://github.com/williamjameshandley/vimteractive/pull/5>`__
:v1.6: CtrlP `bugfix <https://github.com/williamjameshandley/vimteractive/pull/4>`__
Expand Down
18 changes: 8 additions & 10 deletions doc/vimteractive.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,12 @@ Vimteractive was inspired by the workflow of the vim-ipython plugin:

https://github.com/ivanov/vim-ipython

This plugin is designed to extend a subset of the functionality of vimteractive
to other interpreters (including ipython). This plugin is designed to extend a
subset of the functionality of vim-ipython to other interpreters (including
ipython). It is based around the unix philosophy of "do one thing and do it
well". It aims to provide a robust and simple link between text files and
interactive interpreters. Vimteractive will never aim to do things like
autocompletion, leaving that to other, more developed tools such as
YouCompleteMe.
This plugin is designed to extend a subset of the functionality of vim-ipython
to other interpreters (including ipython). It is based around the unix
philosophy of "do one thing and do it well". It aims to provide a robust and
simple link between text files and interactive interpreters. Vimteractive will
never aim to do things like autocompletion, leaving that to other, more
developed tools such as YouCompleteMe.

The activating commands are
- ipython |:Iipython|
Expand Down Expand Up @@ -121,7 +119,7 @@ the terminal.
In |Insert-mode|, CTRL-S sends the line currently being edited, and then
returns to insert mode at the same location.

In |Visual-mode|, CTRL-S sends all currently selected lines to the terminal.
In |Visual-mode|, CTRL-S sends the current selection to the terminal.

ALT-S sends all lines from the start to the current line.

Expand All @@ -132,7 +130,7 @@ create one for you using |:Iterm|.
3. Connecting to existing REPLs *:Iconn* *vimteractive-connecting*
:Iconn [{buffer}] Connect current buffer to REPL in {buffer}. You can
connect any number of buffers to one REPL. {buffer}
can be omited if there is only one terminal.
can be omitted if there is only one terminal.

==============================================================================
4. Extending functionality *vimteractive-extending*
Expand Down

0 comments on commit 308f7f3

Please sign in to comment.