aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorTristan Knight <admin@snappeh.com>2024-09-01 23:46:01 +0100
committerGitHub <noreply@github.com>2024-09-01 15:46:01 -0700
commitbcae8be91f9fd4967f0c6f6ffabf59702253949b (patch)
tree375c68a6e4f0576edced558b8a977252ea1347d6 /runtime/doc
parent61e9137394fc5229e582a64316c2ffef55d8d7af (diff)
downloadrneovim-bcae8be91f9fd4967f0c6f6ffabf59702253949b.tar.gz
rneovim-bcae8be91f9fd4967f0c6f6ffabf59702253949b.tar.bz2
rneovim-bcae8be91f9fd4967f0c6f6ffabf59702253949b.zip
docs: vim.lsp.rpc.connect() TCP requires IP address #30219
"localhost" would work if we used [tcp_connect](https://github.com/luvit/luv/blob/ae0387742b460bc89ebddce33214ad65fffddba2/examples/echo-server-client.lua#L42), but that will require changes to [vim.lsp.rpc.connect](https://github.com/neovim/neovim/blob/318c0415d5b10b44fee4afa06994734f1beb7e71/runtime/lua/vim/lsp/rpc.lua#L638).
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lsp.txt6
1 files changed, 3 insertions, 3 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index e820d54a9e..a8b5825e63 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -2311,14 +2311,14 @@ connect({host_or_path}, {port}) *vim.lsp.rpc.connect()*
Create a LSP RPC client factory that connects to either:
• a named pipe (windows)
• a domain socket (unix)
- • a host and port via TCP
+ • a host and port via TCP (host must be IP address)
Return a function that can be passed to the `cmd` field for
|vim.lsp.start_client()| or |vim.lsp.start()|.
Parameters: ~
- • {host_or_path} (`string`) host to connect to or path to a pipe/domain
- socket
+ • {host_or_path} (`string`) host (IP address) to connect to or path to
+ a pipe/domain socket
• {port} (`integer?`) TCP port to connect to. If absent the
first argument must be a pipe