aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarco Hinz <mh.codebro@gmail.com>2018-11-17 15:30:06 +0100
committerMarco Hinz <mh.codebro@gmail.com>2018-11-17 17:56:34 +0100
commit0c2ca48e5f27ed2dc2cecceffaa83976ee7e9e3e (patch)
treed65806a67e003152df99d2b0419437d7bffe4c7d
parent3ea14d53664ca7dba648e650d4047e01a8518231 (diff)
downloadrneovim-0c2ca48e5f27ed2dc2cecceffaa83976ee7e9e3e.tar.gz
rneovim-0c2ca48e5f27ed2dc2cecceffaa83976ee7e9e3e.tar.bz2
rneovim-0c2ca48e5f27ed2dc2cecceffaa83976ee7e9e3e.zip
doc/python: 'neovim' module was renamed to 'pynvim'
-rw-r--r--runtime/doc/provider.txt16
-rw-r--r--runtime/doc/remote_plugin.txt10
2 files changed, 13 insertions, 13 deletions
diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt
index 0e26dc4515..058e0546cd 100644
--- a/runtime/doc/provider.txt
+++ b/runtime/doc/provider.txt
@@ -19,23 +19,23 @@ Note: Only the Vim 7.3 API is supported; bindeval (Vim 7.4) is not.
PYTHON QUICKSTART ~
-Install the "neovim" Python package:
+Install the "pynvim" Python package:
- Run |:checkhealth| to see if you already have the package (some package
- managers install the "neovim" Python package with Nvim itself).
+ managers install the "pynvim" Python package with Nvim itself).
- For Python 2 plugins, make sure Python 2.7 is available in your $PATH, then
install the package systemwide: >
- sudo pip2 install --upgrade neovim
+ sudo pip2 install --upgrade pynvim
< or for the current user: >
- pip2 install --user --upgrade neovim
+ pip2 install --user --upgrade pynvim
< If "pip2" is missing, try "pip".
- For Python 3 plugins, make sure Python 3.4+ is available in your $PATH, then
install the package systemwide: >
- sudo pip3 install --upgrade neovim
+ sudo pip3 install --upgrade pynvim
< or for the current user: >
- pip3 install --user --upgrade neovim
+ pip3 install --user --upgrade pynvim
< If "pip3" is missing, try "pip".
- The `--upgrade` flag ensures you have the latest version even if a previous
@@ -64,14 +64,14 @@ PYTHON VIRTUALENVS ~
If you plan to use per-project virtualenvs often, you should assign one
virtualenv for Neovim and hard-code the interpreter path via
-|g:python3_host_prog| (or |g:python_host_prog|) so that the "neovim" package
+|g:python3_host_prog| (or |g:python_host_prog|) so that the "pynvim" package
is not required for each virtualenv.
Example using pyenv: >
pyenv install 3.4.4
pyenv virtualenv 3.4.4 py3nvim
pyenv activate py3nvim
- pip install neovim
+ pip install pynvim
pyenv which python # Note the path
The last command reports the interpreter path, add it to your init.vim: >
let g:python3_host_prog = '/path/to/py3nvim/bin/python'
diff --git a/runtime/doc/remote_plugin.txt b/runtime/doc/remote_plugin.txt
index eeb9cf8150..6a9874660b 100644
--- a/runtime/doc/remote_plugin.txt
+++ b/runtime/doc/remote_plugin.txt
@@ -42,15 +42,15 @@ what a Python plugin looks like. This plugin exports a command, a function, and
an autocmd. The plugin is called 'Limit', and all it does is limit the number
of requests made to it. Here's the plugin source code:
>
- import neovim
+ import pynvim
- @neovim.plugin
+ @pynvim.plugin
class Limit(object):
def __init__(self, vim):
self.vim = vim
self.calls = 0
- @neovim.command('Cmd', range='', nargs='*', sync=True)
+ @pynvim.command('Cmd', range='', nargs='*', sync=True)
def command_handler(self, args, range):
self._increment_calls()
self.vim.current.line = (
@@ -58,14 +58,14 @@ of requests made to it. Here's the plugin source code:
args,
range))
- @neovim.autocmd('BufEnter', pattern='*.py', eval='expand("<afile>")',
+ @pynvim.autocmd('BufEnter', pattern='*.py', eval='expand("<afile>")',
sync=True)
def autocmd_handler(self, filename):
self._increment_calls()
self.vim.current.line = (
'Autocmd: Called %s times, file: %s' % (self.calls, filename))
- @neovim.function('Func')
+ @pynvim.function('Func')
def function_handler(self, args):
self._increment_calls()
self.vim.current.line = (