diff options
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* |