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

Add type hints to function signatures #3

Open
2 tasks
volcan01010 opened this issue Jul 14, 2022 · 6 comments
Open
2 tasks

Add type hints to function signatures #3

volcan01010 opened this issue Jul 14, 2022 · 6 comments
Labels
good first issue Good for newcomers

Comments

@volcan01010
Copy link
Owner

Summary

As a BNG user, I want type hints on the function signatures so that my IDE can tell me what types to expect.

Description

Adding type hints (https://realpython.com/lessons/type-hinting/) helps IDEs with autocompletion and gives users information about what inputs they are required to provide.

Acceptance criteria

  • to_osgb36 has type hints on the function signature
  • from_osgb36 has type hints on the function signature
@volcan01010 volcan01010 added the good first issue Good for newcomers label Jul 14, 2022
@Jukelyn
Copy link

Jukelyn commented Jul 18, 2022

Did you want just those two functions to have type hints?

Jukelyn pushed a commit to Jukelyn/bng that referenced this issue Jul 18, 2022
@volcan01010
Copy link
Owner Author

volcan01010 commented Jul 18, 2022 via email

@volcan01010
Copy link
Owner Author

volcan01010 commented Jul 18, 2022 via email

@Jukelyn
Copy link

Jukelyn commented Jul 19, 2022

I've done them and they work for newer Python 3 versions! commit above e714258

@volcan01010
Copy link
Owner Author

volcan01010 commented Jul 19, 2022 via email

@Jukelyn
Copy link

Jukelyn commented Jul 20, 2022

Done! 418f1f0

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

No branches or pull requests

2 participants