@@ -33,7 +33,7 @@ pynvim is installed Neovim will report support for the `+python3` Vim feature.
3333
3434The rplugin interface allows plugins to handle vimL function calls as well as
3535defining commands and autocommands, and such plugins can operate asynchronously
36- without blocking nvim. For details on the new rplugin interface,
36+ without blocking nvim. For details on the new rplugin interface,
3737see the [ Remote Plugin] ( http://pynvim.readthedocs.io/en/latest/usage/remote-plugins.html ) documentation.
3838
3939Pynvim defines some extensions over the vim python API:
@@ -70,7 +70,7 @@ documentation.
7070
7171A number of different transports are supported, but the simplest way to get
7272started is with the python REPL. First, start Nvim with a known address (or use
73- the ` $NVIM_LISTEN_ADDRESS ` of a running instance):
73+ the ` $NVIM_LISTEN_ADDRESS ` of a running instance):
7474
7575``` sh
7676$ NVIM_LISTEN_ADDRESS=/tmp/nvim nvim
@@ -81,10 +81,10 @@ to the one exposed by the [python-vim
8181bridge] ( http://vimdoc.sourceforge.net/htmldoc/if_pyth.html#python-vim ) ):
8282
8383``` python
84- >> > from pynvim import attach
84+ >> > import pynvim
8585# Create a python API session attached to unix domain socket created above:
86- >> > nvim = attach(' socket' , path = ' /tmp/nvim' )
87- # Now do some work.
86+ >> > nvim = pynvim. attach(' socket' , path = ' /tmp/nvim' )
87+ # Now do some work.
8888>> > buffer = nvim.current.buffer # Get the current buffer
8989>> > buffer[0 ] = ' replace first line'
9090>> > buffer[:] = [' replace whole buffer' ]
@@ -99,16 +99,16 @@ You can embed Neovim into your python application instead of connecting to
9999a running Neovim instance.
100100
101101``` python
102- >> > from pynvim import attach
103- >> > nvim = attach(' child' , argv = [" /bin/env" , " nvim" , " --embed" , " --headless" ])
102+ >> > import pynvim
103+ >> > nvim = pynvim. attach(' child' , argv = [" /usr /bin/env" , " nvim" , " --embed" , " --headless" ])
104104```
105105
106- - The ` --headless` argument tells ` nvim ` not to wait for a UI to connect.
106+ - The ` --headless ` argument tells ` nvim ` not to wait for a UI to connect.
107107- Alternatively, use ` --embed ` _ without_ ` --headless ` if your client is a UI
108108 and you want ` nvim ` to wait for your client to ` nvim_ui_attach ` before
109109 continuing startup.
110110
111- See the tests for more examples.
111+ See the [ tests] ( https://github.com/neovim/pynvim/tree/master/test ) for more examples.
112112
113113Release
114114-------
@@ -123,3 +123,8 @@ Release
1231235 . Run ` twine upload -r pypi dist/* `
124124 - Assumes you have a pypi account with permissions.
1251256 . Run ` scripts/enable_log_statements.sh ` or ` git reset --hard ` to restore the working dir.
126+
127+ License
128+ -------
129+
130+ [ Apache License 2.0] ( https://github.com/neovim/pynvim/blob/master/LICENSE )
0 commit comments