aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-07-19 21:32:04 +0200
committerGitHub <noreply@github.com>2019-07-19 21:32:04 +0200
commitafef973262bea3fe1563dc0571bb4168ac0914aa (patch)
tree3fda5cd682a39ee34a8d1b4a2f8dbcb2b13c19c0 /runtime
parentd5f7099be23e217a1fe1f5443257f1b5d1eacfea (diff)
downloadrneovim-afef973262bea3fe1563dc0571bb4168ac0914aa.tar.gz
rneovim-afef973262bea3fe1563dc0571bb4168ac0914aa.tar.bz2
rneovim-afef973262bea3fe1563dc0571bb4168ac0914aa.zip
doc [ci skip] #10383
- test/README.md: document luassert `TableFormatLevel` - CONTRIBUTING.md: absorb parts of the old "Development tips" wiki page
Diffstat (limited to 'runtime')
-rw-r--r--runtime/autoload/python3complete.vim2
-rw-r--r--runtime/autoload/pythoncomplete.vim2
-rw-r--r--runtime/doc/eval.txt19
-rw-r--r--runtime/doc/nvim_terminal_emulator.txt2
-rw-r--r--runtime/doc/options.txt2
-rw-r--r--runtime/doc/provider.txt12
6 files changed, 18 insertions, 21 deletions
diff --git a/runtime/autoload/python3complete.vim b/runtime/autoload/python3complete.vim
index f0f3aaddb3..a3b057d4d0 100644
--- a/runtime/autoload/python3complete.vim
+++ b/runtime/autoload/python3complete.vim
@@ -44,7 +44,7 @@
"
if !has('python3')
- echo "Error: Required vim compiled with +python3"
+ echo 'Error: Requires python3 + pynvim. :help provider-python'
finish
endif
diff --git a/runtime/autoload/pythoncomplete.vim b/runtime/autoload/pythoncomplete.vim
index ecc36646d9..9cc0ae0d79 100644
--- a/runtime/autoload/pythoncomplete.vim
+++ b/runtime/autoload/pythoncomplete.vim
@@ -42,7 +42,7 @@
"
if !has('python')
- echo "Error: Required vim compiled with +python"
+ echo 'Error: Requires python + pynvim. :help provider-python'
finish
endif
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 06af04bf63..01bd2a0c65 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -5351,10 +5351,11 @@ jobwait({ids}[, {timeout}]) *jobwait()*
Wait for a set of jobs to complete.
{ids} is a list of |job-id|s to wait for.
- {timeout} is the maximum number of milliseconds to wait.
+ {timeout} is the maximum waiting time in milliseconds, -1
+ means forever.
- Use zero {timeout} to check the status of a job: >
- let exited = jobwait([{job-id}], 0)[0] >= 0
+ Timeout of 0 can be used to check the status of a job: >
+ let running = jobwait([{job-id}], 0)[0] == -1
<
During jobwait() callbacks for jobs not in the {ids} list may
be invoked. The screen will not redraw unless |:redraw| is
@@ -8572,13 +8573,10 @@ timer_start({time}, {callback} [, {options}])
waiting for input.
{options} is a dictionary. Supported entries:
- "repeat" Number of times to repeat calling the
- callback. -1 means forever. When not present
- the callback will be called once.
+ "repeat" Number of times to repeat the callback.
+ -1 means forever. Default is 1.
If the timer causes an error three times in a
- row the repeat is cancelled. This avoids that
- Vim becomes unusable because of all the error
- messages.
+ row the repeat is cancelled.
Example: >
func MyHandler(timer)
@@ -8586,8 +8584,7 @@ timer_start({time}, {callback} [, {options}])
endfunc
let timer = timer_start(500, 'MyHandler',
\ {'repeat': 3})
-< This will invoke MyHandler() three times at 500 msec
- intervals.
+< This invokes MyHandler() three times at 500 msec intervals.
timer_stop({timer}) *timer_stop()*
Stop a timer. The timer callback will no longer be invoked.
diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt
index 983d04b3bf..d1831a8de6 100644
--- a/runtime/doc/nvim_terminal_emulator.txt
+++ b/runtime/doc/nvim_terminal_emulator.txt
@@ -129,7 +129,7 @@ Example: >
input to the terminal.
Use |jobwait()| to check if the terminal job has finished: >
- let exited = jobwait([&channel], 0)[0] >= 0
+ let running = jobwait([&channel], 0)[0] == -1
==============================================================================
:Termdebug plugin *terminal-debug*
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 8fc8a04df3..84e08ae04b 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -3210,7 +3210,7 @@ A jump table for the options with a short description can be found at |Q_op|.
so far, matches. The matched string is highlighted. If the pattern
is invalid or not found, nothing is shown. The screen will be updated
often, this is only useful on fast terminals.
-< Note that the match will be shown, but the cursor will return to its
+ Note that the match will be shown, but the cursor will return to its
original position when no match is found and when pressing <Esc>. You
still need to finish the search command with <Enter> to move the
cursor to the match.
diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt
index 364fbac351..594c9602f4 100644
--- a/runtime/doc/provider.txt
+++ b/runtime/doc/provider.txt
@@ -57,14 +57,14 @@ If you run into problems, uninstall _both_ then install "pynvim" again: >
PYTHON PROVIDER CONFIGURATION ~
*g:python_host_prog*
-Path to Python 2 interpreter. Setting this makes startup faster. Also useful
-for working with virtualenvs. >
- let g:python_host_prog = '/path/to/python' " Python 2
+Command to start Python 2 (executable, not directory). Setting this makes
+startup faster. Useful for working with virtualenvs. >
+ let g:python_host_prog = '/path/to/python'
<
*g:python3_host_prog*
-Path to Python 3 interpreter. Setting this makes startup faster. Also useful
-for working with virtualenvs. >
- let g:python3_host_prog = '/path/to/python3' " Python 3
+Command to start Python 3 (executable, not directory). Setting this makes
+startup faster. Useful for working with virtualenvs. >
+ let g:python3_host_prog = '/path/to/python3'
<
*g:loaded_python_provider*
To disable Python 2 support: >