aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2024-10-24 15:34:52 +0200
committerJustin M. Keyes <justinkz@gmail.com>2024-10-24 17:24:45 +0200
commit9624fffcfa141335f772938d8c441bdb300e04e6 (patch)
treebd6524e940d9294d48833f2a608a7aec2ebf37f5 /CONTRIBUTING.md
parentdocs: update configs.md (diff)
downloadnvim-lspconfig-9624fffcfa141335f772938d8c441bdb300e04e6.tar
nvim-lspconfig-9624fffcfa141335f772938d8c441bdb300e04e6.tar.gz
nvim-lspconfig-9624fffcfa141335f772938d8c441bdb300e04e6.tar.bz2
nvim-lspconfig-9624fffcfa141335f772938d8c441bdb300e04e6.tar.lz
nvim-lspconfig-9624fffcfa141335f772938d8c441bdb300e04e6.tar.xz
nvim-lspconfig-9624fffcfa141335f772938d8c441bdb300e04e6.tar.zst
nvim-lspconfig-9624fffcfa141335f772938d8c441bdb300e04e6.zip
feat(docs): autogenerate default_config docs
Problem: Docs are manually maintained everywhere for no good reason. Solution: - revert commit 9dc02492c4a457479f8a0ec7a65aac1852ff59c0 - provide a "gF" friendly link to the source
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 979ff78b..212788a0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,9 +29,11 @@ To add a new language server, start with a minimal skeleton. See `:help lspconfi
When choosing a config name, convert dashes (`-`) to underscores (`_`). If the name of the server is a unique name (`pyright`, `clangd`) or a commonly used abbreviation (`zls`), prefer this as the server name. If the server instead follows the pattern x-language-server, prefer the convention `x_ls` (`jsonnet_ls`).
-Populate the `config` table with a `default_config` and `docs` table.
+Populate the `config` table with `default_config` and `docs` tables. Avoid over-architected code. Put lists directly in
+the `default_config` don't add indirection by defining variables elsewhere in the module. The docs are auto-generated by
+reading your `config` source code, so the less indirection in your code, the more useful and obvious the docs will be.
-`default_config` should include at minimum:
+`default_config` should include:
* `cmd`: a list which includes the executable name as the first entry, with arguments constituting subsequent list elements (`--stdio` is common).
```lua