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.

Sign up for GitHub

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

Jump to bottom

Use Python type annotations #123

Open
feltech opened this issue Aug 28, 2024 · 2 comments
Open

Use Python type annotations #123

feltech opened this issue Aug 28, 2024 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Milestone
v1.0.0

Comments

@feltech
Copy link
Member

feltech commented Aug 28, 2024

What

Use Python type annotations consistently across all files

Why

Type annotations make the code easier to understand for both devs and IDEs.
@feltech feltech added good first issue Good for newcomers help wanted Extra attention is needed labels Aug 28, 2024
@feltech feltech mentioned this issue Aug 28, 2024
Merged
@foundry-markf
Copy link

I would also highly recommend as part of this, once type annotations are present, to have them checked for as part of CI, e.g. using mypy. I've seen that usefully spot issues before.

@Srish-ty
Copy link

@feltech @foundry-markf
I would like to work on this issue.
I'll raise the pr by EOD

@SamCrooksFoundry SamCrooksFoundry added this to the v1.0.0 milestone Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
OpenAssetIO Development
Status: Backlog
Milestone
v1.0.0
Development

No branches or pull requests
4 participants
@feltech @foundry-markf @Srish-ty @SamCrooksFoundry