Le 27/07/2012 11:18, DEGREMONT Aurelien a écrit :
Le 27/07/2012 09:43, nap a écrit :

And I don't plan to add them unless someone explain me why it's a good idea to put a explanation about a function between the prototype and the code.
All automatic tool looking for python documentation expect to find them here.
pydoc, epydoc, pylint, ... will be happy with that.
And personnaly I use pydoc a lot when writing code.

I would even add that is a very good idea to stick to "Principle of least astonishment" (http://en.wikipedia.org/wiki/Principle_of_least_astonishment)
Python developers expects to find doc there, keep it there. If you do otherwise:
- they will be disturbed
- they have to learn an other way to get doc for Shinken source only.



Aurélien
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Shinken-devel mailing list
Shinken-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/shinken-devel

Reply via email to