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 /CONTRIBUTING.md | |
| 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 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d2c675ad9..18603321fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -289,7 +289,8 @@ For convenience you can filter the regeneration by target (api, lua, lsp) using ### Lua docstrings -Lua documentation uses a subset of [EmmyLua] annotations. See [:help dev-doc-lua][dev-doc-lua]. +Use [LuaLS] annotations in Lua docstrings to annotate parameter types, return +types, etc. See [:help dev-doc-lua][dev-doc-lua]. - The template for function documentation is: ```lua @@ -340,7 +341,7 @@ as context, use the `-W` argument as well. [conventional_commits]: https://www.conventionalcommits.org [dev-doc-guide]: https://neovim.io/doc/user/develop.html#dev-doc [dev-doc-lua]: https://neovim.io/doc/user/develop.html#dev-lua-doc -[EmmyLua]: https://github.com/sumneko/lua-language-server/wiki/Annotations +[LuaLS]: https://github.com/LuaLS/lua-language-server/wiki/Annotations [gcc-warnings]: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html [gh]: https://cli.github.com/ [git-bisect]: http://git-scm.com/book/en/v2/Git-Tools-Debugging-with-Git |