diff options
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 6 |
1 files changed, 1 insertions, 5 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index c88b8a88c3..107915d017 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -232,11 +232,7 @@ Lua documentation lives in the source code, as docstrings on the function definitions. The |lua-vim| :help is generated from the docstrings. Docstring format: -- Use LuaLS annotations (with minor adjustments, which will be explained - below): https://luals.github.io/wiki/annotations/ -- Lines in the main description start with `--- ` -- Special tokens start with `--- @` followed by the token name: `--- @see`, - `--- @param`, `--- @returns`. Note the space between `---` and `@`. +- Use LuaCATS annotations: https://luals.github.io/wiki/annotations/ - Limited markdown is supported. - List-items start with `-` (useful to nest or "indent") - Use ``` for code samples. |