Skip to content

pydoc doesn't see arguments of Cython functions #1

@ebroder

Description

@ebroder

Cython can't seem to get the list of arguments of a function into the documentation strings, resulting in very helpful docs such as:

>>> help(afs._pts.PTS._NameToId)
Help on method_descriptor:

_NameToId(...)
    Converts a user or group to an AFS ID.

In that particular case, the arguments are easy to guess. That's not always the case.

One relatively good option would be to use epydoc's field specifiers within the docstrings - they're fairly readable and not so constricting as to make it hard to document. Unfortunately, epydoc itself doesn't seem to be able to deal with argument specifiers in __cinit__ methods, but that seems acceptable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions