From bcae8be91f9fd4967f0c6f6ffabf59702253949b Mon Sep 17 00:00:00 2001
From: Tristan Knight <admin@snappeh.com>
Date: Sun, 1 Sep 2024 23:46:01 +0100
Subject: [PATCH] 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).
---
 runtime/doc/lsp.txt         | 6 +++---
 runtime/lua/vim/lsp/rpc.lua | 4 ++--
 2 files changed, 5 insertions(+), 5 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
 
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 7acb67b25e..a9c6723094 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -627,12 +627,12 @@ end
 ---
 ---  - 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()|.
 ---
----@param host_or_path string host to connect to or path to a pipe/domain socket
+---@param host_or_path string host (IP address) to connect to or path to a pipe/domain socket
 ---@param port integer? TCP port to connect to. If absent the first argument must be a pipe
 ---@return fun(dispatchers: vim.lsp.rpc.Dispatchers): vim.lsp.rpc.PublicClient
 function M.connect(host_or_path, port)