Skip to content

Docstring standards in Slycot #100

Closed
@bnavigator

Description

@bnavigator

We have a bunch of different docstring styles used in the various definitions.

Some directly come from the __doc__ property of the wrapper functions generated by f2py, recognizable by the bounds qualifier.

Ar : output rank-2 array('d') with bounds (n,n)

Other functions use shape()

A_z : rank-2 array('d'), shape (n,n)

Sometimes we have blank space between the parameter definitions. Sometimes not.

What's your opinion on unifying this? Adhere to numpydoc and get closer to the documentation in numpy and scipy? Decide on a proper way to specify the shape?

The array('d') is also not consistent with numpydoc, I guess.

Would also affect the math formulas.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions