diff options
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index f36ef1df0a..b3f7d1fadc 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -132,7 +132,7 @@ DOCUMENTATION *dev-doc* optimize for the reader's time and energy: be "precise yet concise". - Prefer the active voice: "Foo does X", not "X is done by Foo". - "The words you choose are an essential part of the user experience." - https://developer.apple.com/design/human-interface-guidelines/foundations/writing/ + https://developer.apple.com/design/human-interface-guidelines/writing - "...without being overly colloquial or frivolous." https://developers.google.com/style/tone - Write docstrings (as opposed to inline comments) with present tense ("Gets"), @@ -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` |