Re: [Shinken-devel] code documentation

2012-07-27 Thread Hartmut Goebel
Am 27.07.2012 21:23, schrieb Hartmut Goebel: > "Convince me" is not such a good argument if you want to attract > developers :-\ I mean: "Convince me why I should follow the standard" is not such a good argument if you want to attract developers :-\ "Convince me" on some other topic should be ok

Re: [Shinken-devel] code documentation

2012-07-27 Thread Hartmut Goebel
Am 27.07.2012 09:43, schrieb nap: > 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. We need the explanation before the prototype, and we need to > see the Doc-strings are the Python way to do

Re: [Shinken-devel] code documentation

2012-07-27 Thread DEGREMONT Aurelien
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

Re: [Shinken-devel] code documentation

2012-07-27 Thread DEGREMONT Aurelien
Le 27/07/2012 09:43, nap a écrit : On Thu, Jul 26, 2012 at 10:48 PM, Hartmut Goebel mailto:h.goe...@crazy-compilers.com>> wrote: Am 26.07.2012 17 :04, schrieb Timo Veith: > is there a code documentation or any plans on doing so? Prior to using a tool like sphinx, we need to add

Re: [Shinken-devel] code documentation

2012-07-27 Thread nap
On Thu, Jul 26, 2012 at 10:48 PM, Hartmut Goebel < h.goe...@crazy-compilers.com> wrote: > Am 26.07.2012 17:04, schrieb Timo Veith: > > is there a code documentation or any plans on doing so? > > Prior to using a tool like sphinx, we need to add usual doc-strings. > Currently often comments are put

Re: [Shinken-devel] code documentation

2012-07-26 Thread Hartmut Goebel
Am 26.07.2012 17:04, schrieb Timo Veith: > is there a code documentation or any plans on doing so? Prior to using a tool like sphinx, we need to add usual doc-strings. Currently often comments are put in front of the function/method/class, but decent doc-strings are missing. See issue #99. Unfort

[Shinken-devel] code documentation

2012-07-26 Thread Timo Veith
Hi, is there a code documentation or any plans on doing so? Like e.g. with sphinx? timo smime.p7s Description: S/MIME Kryptografische Unterschrift -- Live Security Virtual Conference Exclusive live event will cover