aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorKillTheMule <KillTheMule@users.noreply.github.com>2018-01-26 17:42:51 +0100
committerKillTheMule <KillTheMule@users.noreply.github.com>2018-05-23 22:07:27 +0200
commit8bcc01195968b84d1a74ecb82598bdf538004404 (patch)
tree3f730cd4048d22c5c2de53409a599e342dec66b5 /runtime
parent71816e584cef01c195797e738e1d6dba1de39102 (diff)
downloadrneovim-8bcc01195968b84d1a74ecb82598bdf538004404.tar.gz
rneovim-8bcc01195968b84d1a74ecb82598bdf538004404.tar.bz2
rneovim-8bcc01195968b84d1a74ecb82598bdf538004404.zip
Make separate functions to start/stop live updates
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/msgpack_rpc.txt26
1 files changed, 13 insertions, 13 deletions
diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt
index ab77e08bc7..6d5ac25b27 100644
--- a/runtime/doc/msgpack_rpc.txt
+++ b/runtime/doc/msgpack_rpc.txt
@@ -258,24 +258,24 @@ specific buffer. For example, in python >
import sys, neovim
nvim = neovim.attach('stdio')
bufnr = sys.argv[1]
- nvim.buffers[bufnr].live_updates(True)
+ nvim.buffers[bufnr].live_updates_start(True)
-After the `"nvim_buf_live_updates"` method is called, neovim will send a
-series of notifications containing the entire buffer's contents and any
-subsequent changes. The buffer's contents are sent via notifications because
-if you were to use the other API methods to retrieve the buffer contents, the
-buffer could be changed again before you turn on live updates. This can cause
-a delay if your plugin activates live updates for a very large buffer, but it
-is the the most efficient way to maintain a copy of the entire buffer's
-contents inside your plugin.
+After the `"nvim_buf_live_updates_start"` method is called with Argument `"True"`,
+neovim will send a series of notifications containing the entire buffer's
+contents and any subsequent changes. The buffer's contents are sent via
+notifications because if you were to use the other API methods to retrieve the
+buffer contents, the buffer could be changed again before you turn on live
+updates. This can cause a delay if your plugin activates live updates for a
+very large buffer, but it is the the most efficient way to maintain a copy of
+the entire buffer's contents inside your plugin.
*live-updates-disabling*
Turning Off~
-You can use `"nvim_buf_live_updates"` with an argument of `False` to turn off
-notifications. One final notification will be sent to indicate that live
-updates are no longer active for the specified buffer. Alternatively, you can
-just close the channel.
+You can use `"nvim_buf_live_updates_stop"` to turn off notifications. One
+final notification will be sent to indicate that live updates are no longer
+active for the specified buffer. Alternatively, you can just close the
+channel.
*live-updates-limitations*
Limitations~