From: Felix Domke Date: Mon, 20 Feb 2006 22:26:50 +0000 (+0000) Subject: add note about usage of print X-Git-Tag: 2.6.0~4112 X-Git-Url: https://git.cweiske.de/enigma2.git/commitdiff_plain/62937fa5cddcd106c26c950ad336d137f50c6b13?hp=8ba7390e89a4b0282f13c29bd189a1f006e24965 add note about usage of print --- diff --git a/doc/RULES b/doc/RULES index a6283633..ed75b15e 100644 --- a/doc/RULES +++ b/doc/RULES @@ -94,7 +94,25 @@ An ascii file ends with \n, and preferrable not with other empty lines. That means: make sure the last line doesn't contain any characters, thanks. -5.-99.) Threads are bad. +4.) usage of 'print' + +While it's great to dump out debug stuff, especially if your code can crash, +expect your code to be stable at some point. + +At that point, others might get annoyed by the debug output created by your +code. That's no problem, they can remove it, but they have to find them +first. + +Using "print obj" with obj being some object, preferably a complex one, is a +good way to ensure that nobody is able to remove your debug output - because +nobody finds it! + +Please, always prepend something before which can be grepped. Anything, just +not nothing. Going trough all prints to find the offending one is definitely +no fun. Something like "print 'obj', obj" is fine. Something like "print +'mySpecialPlugin actionmap is', actionMap" is even better. + +6.-99.) Threads are bad. (Unless they are worker threads. And sleep()ing is definitely not working. So if you every having a thread which sleeps, you did something wrong. There