aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2020-05-05 07:42:03 -0700
committerJustin M. Keyes <justinkz@gmail.com>2020-05-05 08:45:46 -0700
commit293967a65091097aafcd2dbc71e9f56b8eb34b08 (patch)
tree0db23e8ca5eb24808c7828823874e4913602e235
parent[docgen] Update README.md (diff)
downloadnvim-lspconfig-293967a65091097aafcd2dbc71e9f56b8eb34b08.tar
nvim-lspconfig-293967a65091097aafcd2dbc71e9f56b8eb34b08.tar.gz
nvim-lspconfig-293967a65091097aafcd2dbc71e9f56b8eb34b08.tar.bz2
nvim-lspconfig-293967a65091097aafcd2dbc71e9f56b8eb34b08.tar.lz
nvim-lspconfig-293967a65091097aafcd2dbc71e9f56b8eb34b08.tar.xz
nvim-lspconfig-293967a65091097aafcd2dbc71e9f56b8eb34b08.tar.zst
nvim-lspconfig-293967a65091097aafcd2dbc71e9f56b8eb34b08.zip
doc: spell out when :packadd is needed
https://github.com/neovim/nvim-lsp/issues/220
-rw-r--r--README.md4
-rw-r--r--scripts/README_template.md4
2 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3b8235a2..eb547f13 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ Each config provides a `setup()` function, to initialize the server with
reasonable defaults and some server-specific things like commands or different
diagnostics.
- vim.cmd('packadd nvim-lsp')
+ vim.cmd('packadd nvim-lsp') -- If installed as a Vim "package".
require'nvim_lsp'.<config>.setup{name=…, settings = {…}, …}
Find the [config](#configurations) for your language, then paste the example
@@ -57,7 +57,7 @@ config provides `nvim_lsp.texlab.buf_build({bufnr})`.
To use the defaults, just call `setup()` with an empty `config` parameter.
For the `gopls` config, that would be:
- vim.cmd('packadd nvim-lsp')
+ vim.cmd('packadd nvim-lsp') -- If installed as a Vim "package".
require'nvim_lsp'.gopls.setup{}
### Example: override some defaults
diff --git a/scripts/README_template.md b/scripts/README_template.md
index 511d700c..33693615 100644
--- a/scripts/README_template.md
+++ b/scripts/README_template.md
@@ -42,7 +42,7 @@ Each config provides a `setup()` function, to initialize the server with
reasonable defaults and some server-specific things like commands or different
diagnostics.
- vim.cmd('packadd nvim-lsp')
+ vim.cmd('packadd nvim-lsp') -- If installed as a Vim "package".
require'nvim_lsp'.<config>.setup{name=…, settings = {…}, …}
Find the [config](#configurations) for your language, then paste the example
@@ -57,7 +57,7 @@ config provides `nvim_lsp.texlab.buf_build({bufnr})`.
To use the defaults, just call `setup()` with an empty `config` parameter.
For the `gopls` config, that would be:
- vim.cmd('packadd nvim-lsp')
+ vim.cmd('packadd nvim-lsp') -- If installed as a Vim "package".
require'nvim_lsp'.gopls.setup{}
### Example: override some defaults