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

Attributes field in docstrings of operators #488

Open
mrava87 opened this issue Feb 19, 2023 · 0 comments
Open

Attributes field in docstrings of operators #488

mrava87 opened this issue Feb 19, 2023 · 0 comments

Comments

@mrava87
Copy link
Collaborator

mrava87 commented Feb 19, 2023

Motivation

Historically, every operator has a docstring containing an Attributes section with 2 fields: shape and explicit. This isn’t very informative and outdated as by now each linear operator has more ‘shared’ attributes (common to all operators) than those two. Moreover different operators have different attributes that may be useful to tell users about.

Definition of done

  • Add an Attributes section to LinearOperator which details all of the attributes that are shared among operators (eg shape, dims, dimsd, explicit)
  • Remove or modify the Attributes section in every operator. Remove if the operator does not define interesting attributes in the init method, of modify removing shape and explicit and including those if it does.
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