From 4ba8266ab1212a9c1e3250f3785061ee8d52043e Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sun, 9 Dec 2018 01:49:59 +0100
Subject: doc

- CMake features
---
 runtime/doc/develop.txt | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'runtime/doc/develop.txt')

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*
 
-- 
cgit