Skip to content

Conform to numpydoc #2

Description

@letmaik

This seems to output something that is close to numpydoc but not quite. To integrate with other tools it would be great if actual numpydoc output could be generated. In particular I'm refering to the parameters doc:

doxy2swig:

    Parameters
    ----------
    * `name` :
        the name of the thing

numpydoc:

    Parameters
    ----------
    name
        the name of the thing

It's important to omit the colon after the parameter name as this should only be given when a type is present as well (which doxy2swig doesn't support atm).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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