From 30125e0aaec9af0724e4e2a8d9ebaa8c9d07f698 Mon Sep 17 00:00:00 2001 From: diego Date: Sun, 27 Jun 2004 12:38:38 +0000 Subject: Explain that commenting string operations is important. patch by Alexander Strasser git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@12702 b3059339-0415-0410-9bf9-f77b7e298cf2 --- DOCS/tech/patches.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'DOCS/tech/patches.txt') diff --git a/DOCS/tech/patches.txt b/DOCS/tech/patches.txt index c68b49b15a..e1d298934b 100644 --- a/DOCS/tech/patches.txt +++ b/DOCS/tech/patches.txt @@ -31,7 +31,10 @@ that your patch will be included. 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 -- cgit v1.2.3