• [^] # Re: docstrings

    Posté par . En réponse au journal pimydoc : insérer et actualiser de la doc. Évalué à 7.

    Oui ok, pour d'autres langages peut-être ;), mais pour des projets Python autant éviter de recourir à un outil externe.
    __doc__ est une simple string:

    >>> def foo():
    ... """Super fonction
    ... 
    ... {paragraph}
    ... """
    ... pass
    ... 
    >>> foo.__doc__
    'Super fonction\n\n\t{paragraph}\n\t'
    >>> help(foo)
    Help on function foo in module __main__:
    foo()
     Super fonction
     {paragraph}
    >>> foo.__doc__ = foo.__doc__.format(paragraph="Un paragraphe")
    >>> help(foo)
    Help on function foo in module __main__:
    foo()
     Super fonction
     Un paragraphe