diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2019-03-27 11:11:52 +0100 |
---|---|---|
committer | Justin M. Keyes <justinkz@gmail.com> | 2019-04-08 03:42:21 +0200 |
commit | 27cd1e07ed4117505b29ce4629bf30d2acb1ceca (patch) | |
tree | 7c7db781249b7d067db110344c18060a9f1649e9 /runtime | |
parent | 943bedfc86abb2c6ac20079c1c3a4baac1bd726e (diff) | |
download | rneovim-27cd1e07ed4117505b29ce4629bf30d2acb1ceca.tar.gz rneovim-27cd1e07ed4117505b29ce4629bf30d2acb1ceca.tar.bz2 rneovim-27cd1e07ed4117505b29ce4629bf30d2acb1ceca.zip |
doc [ci skip]
- README.md: Removed waffle.io because that service is shutting down.
Diffstat (limited to 'runtime')
-rw-r--r-- | runtime/doc/api.txt | 2 | ||||
-rw-r--r-- | runtime/doc/autocmd.txt | 5 | ||||
-rw-r--r-- | runtime/doc/message.txt | 7 | ||||
-rw-r--r-- | runtime/doc/provider.txt | 12 | ||||
-rw-r--r-- | runtime/doc/ui.txt | 10 |
5 files changed, 20 insertions, 16 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index e52ed5ad2b..c8b9dd5fad 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -251,7 +251,7 @@ of some window, or a position relative to the current window cursor. The parameters for positioning are described in detail at |nvim_open_win()|. |nvim_open_win()| assumes an existing buffer to display in the window. To create -a scratch buffer for the float, |nvim_create_buffer()| can be used. The text in +a scratch buffer for the float, |nvim_create_buf()| can be used. The text in the buffer can be highlighted using standard functionality, such as syntax highlighting, or |api-highlights|. diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index b6db7b263d..4cc1f53cca 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -640,8 +640,9 @@ CursorHoldI Just like CursorHold, but in Insert mode. *CursorMoved* CursorMoved After the cursor was moved in Normal or Visual - mode. Also when the text of the cursor line - has been changed, e.g., with "x", "rx" or "p". + mode or to another window. Also when the text + of the cursor line has been changed, e.g. with + "x", "rx" or "p". Not triggered when there is typeahead or when an operator is pending. For an example see |match-parens|. diff --git a/runtime/doc/message.txt b/runtime/doc/message.txt index a46648119e..205db12f3b 100644 --- a/runtime/doc/message.txt +++ b/runtime/doc/message.txt @@ -740,11 +740,10 @@ You tried to set an option after startup that only allows changes during startup. *E943* > - Command table needs to be updated, run 'make cmdidxs' + Command table needs to be updated, run 'make' -This can only happen when changing the source code, when adding a command in -src/ex_cmds.h. The lookup table then needs to be updated, by running: > - make cmdidxs +This can only happen when changing the source code, after adding a command in +src/ex_cmds.lua. Update the lookup table by re-running the build. > ============================================================================== 3. Messages *messages* diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt index 070c72a77e..364fbac351 100644 --- a/runtime/doc/provider.txt +++ b/runtime/doc/provider.txt @@ -35,13 +35,13 @@ itself). For Python 3 plugins: 1. Make sure Python 3.4+ is available in your $PATH. -2. Install the module (try "pip" if "pip3" is missing): > - pip3 install --user --upgrade pynvim +2. Install the module (try "python" if "python3" is missing): > + python3 -m pip install --user --upgrade pynvim For Python 2 plugins: 1. Make sure Python 2.7 is available in your $PATH. -2. Install the module (try "pip" if "pip2" is missing): > - pip2 install --user --upgrade pynvim +2. Install the module (try "python" if "python2" is missing): > + python2 -m pip install --user --upgrade pynvim The pip `--upgrade` flag ensures that you get the latest version even if a previous version was already installed. @@ -51,8 +51,8 @@ See also |python-virtualenv|. Note: The old "neovim" module was renamed to "pynvim". https://github.com/neovim/neovim/wiki/Following-HEAD#20181118 If you run into problems, uninstall _both_ then install "pynvim" again: > - pip uninstall neovim pynvim - pip install pynvim + python -m pip uninstall neovim pynvim + python -m pip install --user --upgrade pynvim PYTHON PROVIDER CONFIGURATION ~ diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt index ab077397a4..98476ea8fa 100644 --- a/runtime/doc/ui.txt +++ b/runtime/doc/ui.txt @@ -325,9 +325,13 @@ numerical highlight `id`:s to the actual attributes. indicates the visible cursor position. ["grid_scroll", grid, top, bot, left, right, rows, cols] - Scroll the text in the a region of `grid`. The diagrams below illustrate - what will happen, depending on the scroll direction. "=" is used to - represent the SR(scroll region) boundaries and "-" the moved rectangles. + Scroll a region of `grid`. This is semantically unrelated to editor + |scrolling|, rather this is an optimized way to say "copy these screen + cells". + + The following diagrams show what happens per scroll direction. + "===" represents the SR (scroll region) boundaries. + "---" represents the moved rectangles. Note that dst and src share a common region. If `rows` is bigger than 0, move a rectangle in the SR up, this can |