From 19b8a41c7b8fb31d908b782e8607c04449066ad0 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Fri, 7 Jul 2006 20:54:50 +0000 Subject: [PATCH] Make requirements consistent with doc template wording. --- doc/intro.texi | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/intro.texi b/doc/intro.texi index 5732778..ede0a69 100644 --- a/doc/intro.texi +++ b/doc/intro.texi @@ -492,7 +492,8 @@ make your code self-consistent at the very least. There should not be a patchwork of different styles that makes it obvious that three different people wrote the code. Use horizontal and vertical white space to make code readable. Add a brief comment on every structure, structure -member, global or static variable, and function definition. Update +member, global or static variable, typedef, enumeration, and function +definition. Update existing comments as you modify code. Don't comment out or use the preprocessor to ignore blocks of code (instead, remove it entirely). Use assertions to document key invariants. Decompose code into -- 2.30.2