-
Notifications
You must be signed in to change notification settings - Fork 4
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
Labels
good first issue
Good for newcomers
Comments
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
Yes, please. Those are the only ones that end users will interact with.
…On Mon, 18 Jul 2022, 08:54 Mehraz Ahmed, ***@***.***> wrote:
Did you want just those two functions to have type hints?
—
Reply to this email directly, view it on GitHub
<#3 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AC33O27VUO7EZ6OYKXLQYCTVUUERRANCNFSM53RL2BHQ>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Also, don't worry about backwards compatibility too much. The next release
can be for Python >= 3.7.
…On Mon, 18 Jul 2022, 08:54 Mehraz Ahmed, ***@***.***> wrote:
Did you want just those two functions to have type hints?
—
Reply to this email directly, view it on GitHub
<#3 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AC33O27VUO7EZ6OYKXLQYCTVUUERRANCNFSM53RL2BHQ>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
I've done them and they work for newer Python 3 versions! commit above e714258 |
Thanks!
We need to specify the type for `figs` as well.
Also, can you please update `setup.py` to specify Python 3.7 or greater?
John
…On Tue, 19 Jul 2022, 05:28 Mehraz Ahmed, ***@***.***> wrote:
I've done them and they work for newer Python 3 versions! commit above
e714258
<Jukelyn@e714258>
—
Reply to this email directly, view it on GitHub
<#3 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AC33O24RBCBCIAONR6BVHWDVUYVIDANCNFSM53RL2BHQ>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Done! 418f1f0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 signaturefrom_osgb36
has type hints on the function signatureThe text was updated successfully, but these errors were encountered: