diff options
| author | dundargoc <gocdundar@gmail.com> | 2023-09-15 09:43:48 +0200 |
|---|---|---|
| committer | dundargoc <33953936+dundargoc@users.noreply.github.com> | 2023-10-10 19:20:32 +0200 |
| commit | c3d21ad1bccd9a2975be73b1115213fd884eada3 (patch) | |
| tree | 8c7144e6ddc18a6cf9c097f5516b6f9b74221112 /runtime/doc/develop.txt | |
| parent | fd39f5ce8c9bbda1b77ff6c03553148fadac5d57 (diff) | |
| download | rneovim-c3d21ad1bccd9a2975be73b1115213fd884eada3.tar.gz rneovim-c3d21ad1bccd9a2975be73b1115213fd884eada3.tar.bz2 rneovim-c3d21ad1bccd9a2975be73b1115213fd884eada3.zip | |
docs: small fixes
Co-authored-by: Wansmer <wansmer@gmail.com>
Co-authored-by: Andrew Voynov <andrewvoynov.b@gmail.com>
Co-authored-by: David Moberg <david.moberg@mediatek.com>
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. |