[Buildbot-devel] documenting fileIsImportant in epydoc

Mark Roddy markroddy at gmail.com
Mon Oct 6 03:29:56 UTC 2008


I usually list the expected arguments to the callable in the '@param'
field for the function variable.

-Mark

On Sun, Oct 5, 2008 at 9:15 PM, Charles Lepple <clepple at gmail.com> wrote:
> I am trying to figure out how to document the fileIsImportant callback
> function in the code, so that it shows up in the epydoc output.
>
> Is there a standard way to document the expected parameters for a
> callback? Something like "@type", but relating to the callable itself,
> not the variable referencing the callback?
>
> --
> - Charles Lepple
>
> -------------------------------------------------------------------------
> This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
> Build the coolest Linux based applications with Moblin SDK & win great prizes
> Grand prize is a trip for two to an Open Source event anywhere in the world
> http://moblin-contest.org/redirect.php?banner_id=100&url=/
> _______________________________________________
> Buildbot-devel mailing list
> Buildbot-devel at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/buildbot-devel
>




More information about the devel mailing list