diff options
Diffstat (limited to 'docs/CodingStandards.html')
| -rw-r--r-- | docs/CodingStandards.html | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index ee9443d..7815e19 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -194,9 +194,9 @@ something sane goes a long ways towards avoiding writing documentation.</p> <b>Method information</b> <p>Methods defined in a class (as well as any global functions) should also be -documented properly. A quick note about what it does any a description of the +documented properly. A quick note about what it does and a description of the borderline behaviour is all that is necessary here (unless something -particularly tricky or insideous is going on). The hope is that people can +particularly tricky or insidious is going on). The hope is that people can figure out how to use your interfaces without reading the code itself... that is the goal metric.</p> |