From a0591ec4a38840c0b0235f805dbb0aa19e5e5a34 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Wed, 20 Nov 2024 23:58:37 -0500
Subject: [PATCH] README-documentation-rules.md: Mention not listing types in
param/returns docs.
---
docs/README-documentation-rules.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/docs/README-documentation-rules.md b/docs/README-documentation-rules.md
index ae705378f7ff8..3151de7631073 100644
--- a/docs/README-documentation-rules.md
+++ b/docs/README-documentation-rules.md
@@ -242,6 +242,15 @@ wikiheaders will complain loudly if you don't do this, and exit with an
error message.
+## Don't repeat type names in `\param` and `\returns` sections.
+
+Wikiheaders will explicitly mention the datatype for each parameter and the
+return value, linking to the datatype's wikipage. Users reading the headers
+can see the types in the function signature right below the documentation
+comment. So don't mention the type a second time in the documentation if
+possible. It looks cluttered and repetitive to do so.
+
+
## Code examples go in the wiki.
We don't want the headers cluttered up with code examples. These live on the