diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-07-12 19:27:14 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2023-08-03 14:01:53 +0200 |
| commit | d2f81330247ee060d557330b2716ccea8f789a50 (patch) | |
| tree | cfc05f6f29b46d280a0207d71df51d8cda9b402e /CONTRIBUTING.md | |
| parent | 214b125132778c5d51d4d7e673d31a9be835e150 (diff) | |
| download | rneovim-d2f81330247ee060d557330b2716ccea8f789a50.tar.gz rneovim-d2f81330247ee060d557330b2716ccea8f789a50.tar.bz2 rneovim-d2f81330247ee060d557330b2716ccea8f789a50.zip | |
docs: misc
Co-authored-by: Kevin Pham <keevan.pham@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c49fa7ae0..5d2c675ad9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -304,14 +304,10 @@ Lua documentation uses a subset of [EmmyLua] annotations. See [:help dev-doc-lua ---@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 (e.g. internal or local function), set the doc comment to: - ``` - ---@private - ``` -- Mark deprecated functions with: - ``` - ---@deprecated - ``` +- If a function in your Lua module should _not_ be documented, add `@nodoc`. +- If the function is internal or otherwise non-public add `@private`. + - Private functions usually should be underscore-prefixed (named "_foo", not "foo"). +- Mark deprecated functions with `@deprecated`. Reviewing --------- |