Evolution #46

Probleme Ouvert: doc dans pythonExt

Added by Serge Koudoro almost 9 years ago. Updated almost 9 years ago.

Status:NouveauStart date:
Priority:BasDue date:
Assignee:-% Done:

30%

Category:-
Target version:-

Description

Tracker: Evolution
Priority: Bas

16/05/2005 13:33 (romain)
----------------------------------------------------------------------

Difficulté: *
Module: pythonExt
----------------------------------------------------------------------
Préambule:
En python si on peut faire help(maFonction) pour choper l'aide d'une
fonction définie comme suit:
def maFonction():
"Texte d'aide"
Ça marche aussi dans Morphée avec les fonctions exportées par boost:
boost::python::def("maFonction", &maFonctionCPlusPlus, "Texte d'aide");
Par ailleurs, on peut nommer les arguments:
def renvoieA(a,b):
return a
renvoieA(1,2)
1
renvoieA(2,1)
2
renvoieA(b=2,a=1)
1
Cette fonctionnalité est dispo pour les fonctions C++ exportées par boost::python :
boost::python::def(
"renvoieA" ,
&renvoieACPlusPlus ,
boost::python::args("a","b"),
"renvoieA(a,b): renvoie le premier argument" );
----------------------------------------------------------------------
Problèmes:
1. ajouter les docs qui vont bien aux fonctions exportées dans pythonExt
2. ajouter les lignes boost::python::args pour pouvoir nommer les
arguments, et vérifier que les noms des arguments sont mis dans la
docstring et qu'ils correspondent aux noms déclarés.
3. harmoniser les noms des arguments déclarés pour toutes les fonctions
documentées dans pythonExt.

History

#1 Updated by Serge Koudoro almost 9 years ago

  • % Done changed from 0 to 30

Also available in: Atom PDF