diff options
| author | dundargoc <33953936+dundargoc@users.noreply.github.com> | 2023-09-28 06:57:22 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-27 21:57:22 -0700 |
| commit | 19130415183763a572c50c8ae343dff8cc20526e (patch) | |
| tree | ce58255138c6914c577f3afe0e42d36e0b753cd6 /CONTRIBUTING.md | |
| parent | e46f5aab895f333d23d6adf490e13177c8d3c1d8 (diff) | |
| download | rneovim-19130415183763a572c50c8ae343dff8cc20526e.tar.gz rneovim-19130415183763a572c50c8ae343dff8cc20526e.tar.bz2 rneovim-19130415183763a572c50c8ae343dff8cc20526e.zip | |
docs: Lua docstrings guidance #25345
Recommend adding a space after i.e. `--- @see`.
The "space" variant is common for the vast majority of docstring formats
such as doxygen, javadoc and typescript.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7eed75f0d4..2128b3af13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -308,11 +308,11 @@ types, etc. See [:help dev-doc-lua][dev-doc-lua]. --- --- {Long explanation} --- - ---@param arg1 type {description} - ---@param arg2 type {description} + --- @param arg1 type {description} + --- @param arg2 type {description} --- ... --- - ---@return type {description} + --- @return type {description} ``` - If possible, add type information (`table`, `string`, `number`, ...). Multiple valid types are separated by a bar (`string|table`). Indicate optional parameters via `type|nil`. - If a function in your Lua module should _not_ be documented, add `@nodoc`. |