docs: regenerate

Shougo · Sep 5, 2021 · c910475 · c910475
1 parent dce5031
commit c910475
Showing 1 changed file with 21 additions and 20 deletions.
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
@@ -819,32 +819,33 @@ nvim_get_api_info()                                      *nvim_get_api_info()*
                     {fast}
 
 nvim_get_chan_info({chan})                              *nvim_get_chan_info()*
-                Get information about a channel.
+                Gets information about a channel.
 
                 Return: ~
                     Dictionary describing a channel, with these keys:
-                    • "stream" the stream underlying the channel
+                    • "id" Channel id.
+                    • "argv" (optional) Job arguments list.
+                    • "stream" Stream underlying the channel.
                       • "stdio" stdin and stdout of this Nvim instance
                       • "stderr" stderr of this Nvim instance
                       • "socket" TCP/IP socket or named pipe
-                      • "job" job with communication over its stdio
-
-                    • "mode" how data received on the channel is interpreted
-                      • "bytes" send and receive raw bytes
-                      • "terminal" a |terminal| instance interprets ASCII
-                        sequences
-                      • "rpc" |RPC| communication on the channel is active
-
-                    • "pty" Name of pseudoterminal, if one is used (optional).
-                      On a POSIX system, this will be a device path like
-                      /dev/pts/1. Even if the name is unknown, the key will
-                      still be present to indicate a pty is used. This is
-                      currently the case when using winpty on windows.
-                    • "buffer" buffer with connected |terminal| instance
-                      (optional)
-                    • "client" information about the client on the other end
-                      of the RPC channel, if it has added it using
-                      |nvim_set_client_info()|. (optional)
+                      • "job" Job with communication over its stdio.
+
+                    • "mode" How data received on the channel is interpreted.
+                      • "bytes" Send and receive raw bytes.
+                      • "terminal" |terminal| instance interprets ASCII
+                        sequences.
+                      • "rpc" |RPC| communication on the channel is active.
+
+                    • "pty" (optional) Name of pseudoterminal. On a POSIX
+                      system this is a device path like "/dev/pts/1". If the
+                      name is unknown, the key will still be present if a pty
+                      is used (e.g. for winpty on Windows).
+                    • "buffer" (optional) Buffer with connected |terminal|
+                      instance.
+                    • "client" (optional) Info about the peer (client on the
+                      other end of the RPC channel), if provided by it via
+                      |nvim_set_client_info()|.
 
 nvim_get_color_by_name({name})                      *nvim_get_color_by_name()*
                 Returns the 24-bit RGB value of a |nvim_get_color_map()| color