Mercurial > mplayer.hg

changeset 12701:4e0acc8d3622

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Explain that commenting string operations is important. patch by Alexander Strasser <eclipse7@gmx.net>
author diego
date Sun, 27 Jun 2004 12:38:38 +0000
parents 5ef61921bb78
children b6d1267f189e
files DOCS/tech/patches.txt
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/DOCS/tech/patches.txt	Sun Jun 27 12:20:51 2004 +0000
+++ b/DOCS/tech/patches.txt	Sun Jun 27 12:38:38 2004 +0000
@@ -31,7 +31,10 @@
     any remaining cosmetics!
 
  5. Comment parts that really need it (tricky side-effects etc).
-    Commenting trivial code not required. Comments must be English!
+    Always document string operations! Comment on what you are doing
+    and why it is safe. This makes it easy to review and change your
+    code if needed. Commenting trivial code not required.
+    Comments must be English!
 
  6. If you implement new features, add or change command line switches or
     modify the behavior of existing features, please do not forget to also