[Bf-python] general guidelines
Jordi Rovira i Bonet
jordi.rovira at ima.udg.es
Fri Jun 20 12:12:04 CEST 2003
Willian Padovani Germano wrote:
>On Thu, 2003-06-19 at 18:20, Jacques Guignot wrote:
>
>
>>Would you agre with this (simple) guideline ?
>>
>>Every module consists of 4 files
>>Module.c
>>Module.h
>>testmodule.py : (python script) exhaustive testing of the module
>>Moduledoc.txt : documentation (plain text)
>>
>>
>
>That's it, but the documentation will probably be on a "fake" Module.py,
>that only contains function and class definitions and the docstrings,
>for the epydoc documentation. Look at the api2_2x/doc dir, I'll commit
>it soon.
>
>
There's something i don't understand here... Why write documentation in
a fake module and not simply write the documentation? If a fake module
has to be made, why use a documentation extraction tool? It doesn't make
sense to me...
(bandoler)
More information about the Bf-python
mailing list