aboutsummaryrefslogtreecommitdiffstats
path: root/doc/nvim-lsp-installer.txt
diff options
context:
space:
mode:
authorWilliam Boman <william@redwill.se>2021-04-05 14:19:07 +0200
committerGitHub <noreply@github.com>2021-04-05 14:19:07 +0200
commitdcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb (patch)
tree419e086d757624aa9e2bcaa456e02a6c8f7a3968 /doc/nvim-lsp-installer.txt
parenteslintls: avoid globbing/word splitting (diff)
downloadmason-dcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb.tar
mason-dcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb.tar.gz
mason-dcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb.tar.bz2
mason-dcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb.tar.lz
mason-dcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb.tar.xz
mason-dcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb.tar.zst
mason-dcf117a8a60d887a2c2ff9d5617a9c39c5ee95fb.zip
rename Installer to Server for clarity (#3)
Diffstat (limited to 'doc/nvim-lsp-installer.txt')
-rw-r--r--doc/nvim-lsp-installer.txt34
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/nvim-lsp-installer.txt b/doc/nvim-lsp-installer.txt
index d32915b6..5a19198d 100644
--- a/doc/nvim-lsp-installer.txt
+++ b/doc/nvim-lsp-installer.txt
@@ -49,12 +49,12 @@ Then, somewhere in your initialization script (see `:h init.lua`): >
COMMANDS *nvim-lsp-installer-commands*
*:LspInstall*
-:LspInstall {server}
+:LspInstall {server_name}
Installs a language server
*:LspUninstall*
-:LspUninstall {server}
+:LspUninstall {server_name}
Uninstalls a language server.
@@ -80,38 +80,38 @@ Lua module: nvim-lsp-installer *lsp_installer*
*lsp_installer.get_available_servers()*
get_available_servers()
Return: ~
- (string[]) A list containing all available language servers.
+ |lsp_installer.Server|[] A list containing all available language servers.
*lsp_installer.get_installed_servers()*
get_installed_servers()
Return: ~
- (Installer[]) A list of installers. See |lsp_installer.Installer|.
+ |lsp_installer.Server|[] A list of servers that are currently installed.
*lsp_installer.get_uninstalled_servers()*
get_uninstalled_servers()
Return: ~
- (string[]) A list of servers that are not installed.
+ |lsp_installer.Server|[] A list of servers that are not installed.
*lsp_installer.install()*
-install({server})
- Installs the provided {server}. If {server} is already installed, it
+install({server_name})
+ Installs the provided {server_name}. If {server_name} is already installed, it
is reinstalled.
Parameters: ~
- {server} (string) The server to install.
+ {server_name} (string) The server to install.
*lsp_installer.uninstall()*
-uninstall({server})
- Uninstalls the provided {server}.
+uninstall({server_name})
+ Uninstalls the provided {server_name}.
Parameters: ~
- {server} (string) The server to uninstall.
+ {server_name} (string) The server to uninstall.
==============================================================================
-Lua module: nvim-lsp-installer.installer *lsp_installer.installer*
+Lua module: nvim-lsp-installer.server *lsp_installer.server*
- *lsp_installer.Installer*
-class: Installer
+ *lsp_installer.Server*
+class: Server
This class enables installing, uninstalling, and setting up language
servers.
@@ -124,12 +124,12 @@ class: Installer
{opts}.
- is_installed()
- Returns {true} is installer is installed, else returns {false}.
+ Returns {true} is server is installed, else returns {false}.
- install()
- Installs this instance of an installer.
+ Installs this instance of an LSP server.
- uninstall()
- Uninstalls this instance of an installer.
+ Uninstalls this instance of an LSP server.
vim:tw=78:ft=help:norl: