diff options
| author | Ashkan Kiani <ashkan.k.kiani@gmail.com> | 2019-11-14 11:01:16 -0800 |
|---|---|---|
| committer | Ashkan Kiani <ashkan.k.kiani@gmail.com> | 2019-11-14 11:01:16 -0800 |
| commit | 13c8ca22cab731a61963f52647949ad89287c096 (patch) | |
| tree | 981b44d8cfaa2662f31dbb72546d1cf994533022 /CONTRIBUTING.md | |
| parent | Add initial support for python-language-server (#3) (diff) | |
| download | nvim-lspconfig-13c8ca22cab731a61963f52647949ad89287c096.tar nvim-lspconfig-13c8ca22cab731a61963f52647949ad89287c096.tar.gz nvim-lspconfig-13c8ca22cab731a61963f52647949ad89287c096.tar.bz2 nvim-lspconfig-13c8ca22cab731a61963f52647949ad89287c096.tar.lz nvim-lspconfig-13c8ca22cab731a61963f52647949ad89287c096.tar.xz nvim-lspconfig-13c8ca22cab731a61963f52647949ad89287c096.tar.zst nvim-lspconfig-13c8ca22cab731a61963f52647949ad89287c096.zip | |
Improve documentation and docgen command.
Also improve the recommended command for running docgen.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 407eba7b..efa8af67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,8 +11,10 @@ from `nvim` to run. It **must** be run from the .git/project root. This could be modified to try to find the .git root with one of our `util.*` functions potentially. -So you can either run nvim with cwd at the project root, or run `nvim +"luafile -scripts/docgen.lua" +q` from the project root. +You can run +`nvim -u NONE +'set rtp+=$PWD' +"luafile scripts/docgen.lua" +q` +from the project root. This ensures that it doesn't pick up another +copy of `nvim_lsp` on your system. This generates a suffix for README.md |