diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2022-06-13 01:12:52 -0700 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2022-06-13 01:44:59 -0700 |
| commit | 4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176 (patch) | |
| tree | d448c2954948c3c241d3dc86d724f6e964cd3061 /CONTRIBUTING.md | |
| parent | docs: update server_configurations.md (diff) | |
| download | nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.gz nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.bz2 nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.lz nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.xz nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.tar.zst nvim-lspconfig-4f94bf5ba90e97a9718e5a2eb57b0737e1bdd176.zip | |
docs: unverbose, mention "settings" param
Problem:
- The docs are verbose.
- The "settings" param is not really clarified anywhere.
Solution:
- Mention the "settings" param in the README.
- Tighten up the wording.
- Remove the "Use a loop to conveniently call 'setup'..." advice in the
docs. It confuses users and doesn't really save much code.
- Start to reduce the scope of nvim-lspconfig.
- For example, it is redundant for it to document general LSP things.
Thus, the help section *lspconfig-lsp* was removed.
closes #1951
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7eea3f74..e97d6591 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -125,7 +125,7 @@ PRs are checked with [luacheck](https://github.com/mpeterv/luacheck), [StyLua](h ## Generating docs -Github Actions automatically generates `server_configurations.md`. Only modify `scripts/README_template.md` or the `docs` table in the server config (the lua file). Do not modify `server_configurations.md` directly. +Github Actions automatically generates `server_configurations.md`. Only modify `scripts/README_template.md` or the `docs` table in the server config Lua file. Do not modify `server_configurations.md` directly. To preview the generated `server_configurations.md` locally, run `scripts/docgen.lua` from `nvim` (from the project root): |