Re: [Gnumed-devel] Epydoc

[Jim Busser]

On Jun 20, 2004, at 10:34 AM, Karsten Hilbert wrote:
> those imported files with an "undefined" _() still work IF
> imported by something that already imported gmI18N before
> them. However, if run standalone they break down (which is
> what EpyDoc doesn't like).
> --->  "... import gmI18N" in those files ?

On Jun 22, 2004, at 6:29 AM, Hilmar Berger wrote:
> On Sunday 20 June 2004 09:41, Sebastian Hilbert wrote:
> > BTW. I noticed that a lot of functions don't get picked up by epydoc. I
> > would assume this is due to the coding style. Could someone please
> > take a look and tell me what exactly needs to be done for
> > epydoc to pick up and document the functions.
> > Often epydoc documents just the classes and variables.
> Seems like epydoc just list non-private methods (i.e. those which do not
> start with __method_name) - this makes a lot of sense, since this is an API
> documentation. 
> If you want some descriptive text, use docstrings ("""asd""") below the
> method name.

Once we identify & confirm that a "desired method/style" of commenting --- including any need to import gmI18N --- gives the desired effect in Epydoc, I can add it to the wiki section "Coding and Module-design guidelines". It is at
http://hherb.com/cgi-bin/twiki/view/Gnumed/DevelopmentGuidelines