diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-08-03 13:41:47 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2023-08-03 14:01:53 +0200 |
| commit | b1fb04475e6fa0c44895cb6fe97b75816d74c297 (patch) | |
| tree | 31873cf0a47cec025155d0b52d72a3ab5ea5bd12 /runtime/doc/develop.txt | |
| parent | d2f81330247ee060d557330b2716ccea8f789a50 (diff) | |
| download | rneovim-b1fb04475e6fa0c44895cb6fe97b75816d74c297.tar.gz rneovim-b1fb04475e6fa0c44895cb6fe97b75816d74c297.tar.bz2 rneovim-b1fb04475e6fa0c44895cb6fe97b75816d74c297.zip | |
docs: remove "#" comment char in @return
Everything after a "#" char is a "description" comment, i.e. luals won't
treat it as a type, name, etc. But "#" should not be present in the
generated docs (such as :help docs).
https://github.com/LuaLS/lua-language-server/wiki/Annotations#return
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index 25f570e38a..b3f7d1fadc 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -226,6 +226,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: https://github.com/LuaLS/lua-language-server/wiki/Annotations - Lines in the main description start with `---` - Special tokens start with `---@` followed by the token name: `---@see`, `---@param`, `---@returns` |