Skip to content

Aliases in documentation #156

@paquiteau

Description

@paquiteau

with the new PySAP cross-plugins documentation, there is a need to harmonized the type specified in docstrings.
This goes for the "Parameters" and "Returns" sections but also for the "See Also" which refer to related implementations.

  • np.ndarray -> numpy.ndarray
  • OperatorBase, FourierOperatorBase -> add full module path
  • ReconstructorBase -> add full module path

I will add any other relevant changes to this issue.

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