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

Improve type annotations #284

Open
bwohlberg opened this issue May 1, 2022 · 0 comments
Open

Improve type annotations #284

bwohlberg opened this issue May 1, 2022 · 0 comments
Labels
typing Related to type annotations

Comments

@bwohlberg
Copy link
Collaborator

bwohlberg commented May 1, 2022

Current type annotation usage is in need of some attention:

  1. Many functions and methods still do not have type annotations, e.g. jvp, jhvp, and vjp in scico.operator.
  2. Figure out how to annotate a dynamically generated module so that the typing system is aware of the dynamically constructed functions.
  3. Revisit the numerous lines of code marked as # type: ignore to determine whether the error that led to its insertion can instead be resolved by improved type annotation or use of type guards.
  4. Review class structure with a view to minimization violations of the Liskov substitution principle (e.g. see issues with prox method).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typing Related to type annotations
Projects
None yet
Development

No branches or pull requests

2 participants