diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2018-12-30 21:17:18 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-30 21:17:18 +0100 |
| commit | 1e8d2bdc487cdebf152eb228ed936720cfed3a76 (patch) | |
| tree | f4933a9250ac93d6dd6998b9bafb87bb1beae8ab /runtime/doc/develop.txt | |
| parent | fa5182489a660e672bac6ea78ba4eefcbba9d6eb (diff) | |
| parent | a10fdc70aa1e7e48421a473a2fab49b79089426c (diff) | |
| download | rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.tar.gz rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.tar.bz2 rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.zip | |
Merge #9335 from justinmk/doc
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index 2c919f9104..e244072c66 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -137,6 +137,13 @@ DOCUMENTATION *dev-doc* "the user host terminal". - Use "tui-" to prefix help tags related to the host terminal, and "TUI" in prose if possible. +- Docstrings: do not start parameter descriptions with "The" or "A" unless it + is critical to avoid ambiguity. + GOOD: > + /// @param dirname Path fragment before `pend` +< BAD: > + /// @param dirname The path fragment before `pend` +< API *dev-api* |