Morph-M

Reference/Publis des algorithmes dans la doc c++/python de MorphM,
---------------------------------------------------------------------------

Description:
----------------------------------------
Bonjour
Ce post fait suite a un très judieuce remarque de notre nouveau post doc
Romaric.
Qui indique a juste titre que la documentation des algos de MorphM ne vient pas
toujours avec une citation/Ref de la publication/Note Interne de
l'implémentation sous jacente.
Cette documentation a été partiellement réalisé pour l'interface c++ mais pas
forcément répercuté dans le code python.
De plus (et malheureusement) la doc python de nombreux modules se limite trop
souvent a Help(NomDeMaFonction)-> NomDeMaFonction ce qui n'est pas très
informatif pour un utilisateur lambda.
Notons que si un peu de monde s'y met cela peut être rapidement corrigé.....
Notons également que moi comme thibault, n'avons pas (en plus de maintenir tous
le code, les compils nocturnes, les pbs de chacun, une partit des ateliers,
...)de temps a consacrer a ce genre de choses.
Je vous invite d'ailleurs a voir les excellentes Doc des addons de Thibault pour
voir que oui en python on peut faire de la doc qui tient la route:
http://rhodes.ensmp.fr/morphee_doc/all_python/module_MorpheeInpaintingPython.htm
l

#1 25/09/2007 16:45 (Thomas)
---------------------------------------------------------------------------
Change: status: "pending" -> "accepted"
Change: assignees: "[]" -> "['ali', 'faessel', 'morphmdev', 'noyel']"
Change: topic: "" -> "UI"
Change: solution: "" -> "Ben faut juste le faire dans les bouts de codes quand on se balade dedans et commité....

Faudrait aussi le faire dans les users si ils sont amanés a servir a quelqu'un d'autres que la personne qui a écrit le code. Car tout code non documenté va invariablement au bout de quelques heures d'énervement à la corbeille. Les plus anciens ce rappeleront des codes de Lothar Bergen que personne n'a jamais pu réutiliser.

" 
Change: importance: "medium" -> "low" 
Change: title: "" -> "Reference/Publis des algorithmes dans la doc c++/python de MorphM" 
Change: classification: "Bug" -> "Documentation" 
Change: description: "" -> "Bonjour

Ce post fait suite a un très judieuce remarque de notre nouveau post doc Romaric.

Qui indique a juste titre que la documentation des algos de MorphM ne vient pas toujours avec une citation/Ref de la publication/Note Interne de l'implémentation sous jacente.

Cette documentation a été partiellement réalisé pour l'interface c++ mais pas forcément répercuté dans le code python.
De plus (et malheureusement) la doc python de nombreux modules se limite trop souvent a Help(NomDeMaFonction)-> NomDeMaFonction ce qui n'est pas très informatif pour un utilisateur lambda.

Notons que si un peu de monde s'y met cela peut être rapidement corrigé.....

Notons également que moi comme thibault, n'avons pas (en plus de maintenir tous le code, les compils nocturnes, les pbs de chacun, une partit des ateliers, ...)de temps a consacrer a ce genre de choses.

Je vous invite d'ailleurs a voir les excellentes Doc des addons de Thibault pour voir que oui en python on peut faire de la doc qui tient la route:

http://rhodes.ensmp.fr/morphee_doc/all_python/module_MorpheeInpaintingPython.html

"