diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-09-20 04:15:23 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-20 04:15:23 -0700 |
| commit | 1b55f51d0d8468ca357514a868ac8e188b0c8722 (patch) | |
| tree | 7212864dc2bcaa4ff2e6123620d6596692826509 /CONTRIBUTING.md | |
| parent | 50d5fcc0bc1a3a67b9c3cc7066d97593ea3cc22d (diff) | |
| download | rneovim-1b55f51d0d8468ca357514a868ac8e188b0c8722.tar.gz rneovim-1b55f51d0d8468ca357514a868ac8e188b0c8722.tar.bz2 rneovim-1b55f51d0d8468ca357514a868ac8e188b0c8722.zip | |
docs: misc #24561
fix #24699
fix #25253
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fe3c39bde..7eed75f0d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ low-risk/isolated tasks: - Try a [complexity:low] issue. - Fix bugs found by [Clang](#clang-scan-build), [PVS](#pvs-studio) or [Coverity](#coverity). -- [Improve documentation](#documenting) +- [Improve documentation](#documentation) - [Merge a Vim patch] (requires strong familiarity with Vim) - NOTE: read the above link before sending improvements to "runtime files" (anything in `runtime/`). - Vimscript and documentation files are (mostly) maintained by [Vim](https://github.com/vim/vim), not Nvim. @@ -267,8 +267,8 @@ to `runtime/lua/vim/_editor.lua` then: VIMRUNTIME=./runtime ./build/bin/nvim --luamod-dev ``` -Documenting ------------ +Documentation +------------- Read [:help dev-doc][dev-doc-guide] to understand the expected documentation style and conventions. @@ -287,10 +287,15 @@ If you need to modify or debug the documentation flow, these are the main files: - `./scripts/lua2dox.lua`: Used by `gen_vimdoc.py` to transform Lua files into a format compatible with doxygen. - `./scripts/gen_eval_files.lua`: - Generates documentation and Lua type files from metadata files including: - - Eval functions (`src/nvim/eval.lua`) - - Options (`src/nvim/options.lua`) - - API + Generates documentation and Lua type files from metadata files: + ``` + runtime/lua/vim/* => runtime/doc/lua.txt + runtime/lua/vim/* => runtime/doc/lua.txt + runtime/lua/vim/lsp/ => runtime/doc/lsp.txt + src/nvim/api/* => runtime/doc/api.txt + src/nvim/eval.lua => runtime/doc/builtin.txt + src/nvim/options.lua => runtime/doc/options.txt + ``` ### Lua docstrings |