diff options
| author | Michael Lingelbach <m.j.lbach@gmail.com> | 2020-01-31 00:00:50 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-31 00:00:50 -0800 |
| commit | b487481e19ab803f2fac1c7acc10c83c743dd39b (patch) | |
| tree | 9eb735e6c3ab6e75ca767ee0ab886e6ba5ce32de /CONTRIBUTING.md | |
| parent | [docgen] Update README.md (diff) | |
| download | nvim-lspconfig-b487481e19ab803f2fac1c7acc10c83c743dd39b.tar nvim-lspconfig-b487481e19ab803f2fac1c7acc10c83c743dd39b.tar.gz nvim-lspconfig-b487481e19ab803f2fac1c7acc10c83c743dd39b.tar.bz2 nvim-lspconfig-b487481e19ab803f2fac1c7acc10c83c743dd39b.tar.lz nvim-lspconfig-b487481e19ab803f2fac1c7acc10c83c743dd39b.tar.xz nvim-lspconfig-b487481e19ab803f2fac1c7acc10c83c743dd39b.tar.zst nvim-lspconfig-b487481e19ab803f2fac1c7acc10c83c743dd39b.zip | |
rename "skeleton" to "configs" #100
`nvim_lsp/skeleton.lua` is not really a skeleton, it's a `configs`
class that provides
1. actual functionality
2. a bunch of configs
Each config is added to the `configs` object (FKA "skeleton") as
a property. Those configs are not "templates", they are "configs". So we
should clean up the wording in various places to say "config" instead of
"skeleton"/"template".
Closes #64
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f89c8426..3099bb85 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,15 +18,15 @@ To preview the generated `README.md` locally, source `scripts/docgen.lua` from It **must** be run from the `.git`/project root. (TODO: try to find the `.git` root with one of our `util.*` functions?) -# skeleton +# configs -skeleton has a `__newindex` metamethod which validates and creates +configs has a `__newindex` metamethod which validates and creates an object containing `setup()`, which can then be retrieved and modified. In `vim.validate` parlance, this is the "spec": ``` -skeleton.SERVER_NAME = { +configs.SERVER_NAME = { default_config = {'t'}; on_new_config = {'f', true}; on_attach = {'f', true}; @@ -40,7 +40,7 @@ docs = { ``` - Keys of the `docs.default_config` table match those of - `skeleton.SERVER_NAME.default_config`, and can be used to specify custom + `configs.SERVER_NAME.default_config`, and can be used to specify custom documentation. This is useful for functions, whose docs cannot be easily auto-generated. - The `commands` object is a table of `name:definition` key:value pairs, where @@ -63,12 +63,12 @@ Example: ``` -After you create `skeleton.SERVER_NAME`, you may add arbitrary +After you create `configs.SERVER_NAME`, you may add arbitrary language-specific functions to it if necessary. Example: - skeleton.texlab.buf_build = buf_build + configs.texlab.buf_build = buf_build Finally, add a `require 'nvim_lsp/SERVER_NAME'` line to `lua/nvim_lsp.lua`. |
