kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 03:05:11 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc/python: 'neovim' module was renamed to 'pynvim'

Browse Source
This commit is contained in:
Marco Hinz 2018-11-17 15:30:06 +01:00
parent 3ea14d5366
commit 0c2ca48e5f
No known key found for this signature in database
GPG Key ID: 1C980A1B657B4A4F
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
runtime/doc/provider.txt
View File

@ -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'

10
runtime/doc/remote_plugin.txt
View File

@ -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 = (