Some more docs for bts-link

[Olivier Berger]

Le lundi 26 janvier 2009 à 22:25 +0100, Sandro Tosi a écrit :
> On Mon, Jan 26, 2009 at 13:57, Olivier Berger
> <olivier.berger at it-sudparis.eu> wrote:
> > Hi.
> >
> > I've started to try and be able to publish some improvements to bts-link
> > through git (learning git along the way ;) at :
> > http://git.debian.org/?p=users/olberger-guest/bts-link.git;a=summary
> >
> > The first commit I've made concerns some more docs I collected along the
> > learning of bts-link's internals.
> 
> I give it a look: why didn't you use docstrings instead of comments,
> like in bts/interfaces.py classes?

I used to be a Pythonist myself 10 years ago and ahve forgotten the
proper docstrings way to do in Python... and as doxygen seems to be
quite popular, I thought maybe something not only "pythonic" would be
better maybe... but I must say I started and didn't go any further.

In any case, having some easily generated documentation in the form of
HTML would probably help navigate the bts-link code.

> 
> There are some doc I don't feel that necessary (__name__ == '__main__'
> one, for example), but hey, it's doc! :)

Well, for Pythonists it's obvious of course, but I'm thinking as
improving general maintainability of code for more contribs from any
people knowing at least an other language, and not necessarily Python
folks.

> 
> Reply when you've updated that repo, and I'll be giving it another look.
> 

You may expect more useful contribs (support for other trackers for
instance, like gforge and such), hopefully some day soon, but I'm
currently also busy starting Helios WP3 in non-coding way, and learning
ontologies and such... so hard to find time to re-open eclipse and play
with git, python, etc ;)

Thanks for your comments anyway.

Regards,
-- 
Olivier BERGER <olivier.berger at it-sudparis.eu>
http://www-public.it-sudparis.eu/~berger_o/ - OpenPGP-Id: 1024D/6B829EEC
Ingénieur Recherche - Dept INF
Institut TELECOM, SudParis (http://www.it-sudparis.eu/), Evry (France)