diff options
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index db878ac304..f36ef1df0a 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -233,6 +233,8 @@ Docstring format: - List-items start with `-` (useful to nest or "indent") - Use `<pre>` for code samples. Code samples can be annotated as `vim` or `lua` +- Use `@nodoc` to prevent documentation generation. +- Files which has `@meta` are only used for typing and documentation. Example: the help for |vim.paste()| is generated from a docstring decorating vim.paste in runtime/lua/vim/_editor.lua like this: > |