Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aliases in documentation #156

Open
1 of 3 tasks
paquiteau opened this issue Jun 24, 2022 · 0 comments
Open
1 of 3 tasks

Aliases in documentation #156

paquiteau opened this issue Jun 24, 2022 · 0 comments

Comments

@paquiteau
Copy link
Contributor

paquiteau commented Jun 24, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant