Skip to content

Should function and class docstrings mirror the Eigen documentation? #15

Description

@Lucas-Haubert

Yet, some commentaries / descriptions of the functions / classes are not strictly equivalent to the ones in the Eigen source code.
Should we make a perfect mirror of this documentation ?

One example, in eigen/decompositions.LDLT.hpp:

.def("matrixL", &matrixL, bp::arg("self"),
             "Returns the lower triangular matrix L.")

but in source code:

Returns a view of the lower triangular matrix L.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions