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 package's typing #1062

Open
5 of 17 tasks
bonjourmauko opened this issue Oct 7, 2021 · 0 comments
Open
5 of 17 tasks

Improve package's typing #1062

bonjourmauko opened this issue Oct 7, 2021 · 0 comments
Assignees
Labels
kind:docs Add or improvement of documentation kind:roadmap A group of issues, constituting a delivery roadmap

Comments

@bonjourmauko
Copy link
Member

bonjourmauko commented Oct 7, 2021

Hi there!

Here is what I did:

I used a function expecting an int as argument, with a str argument.

Here is what I expected to happen:

To get an error from make check-types.

Here is what actually happened:

Nothing.

Context:

Type-hinting is an inexpensive way of :

  • Documenting the code
  • Building the documentation
  • Finding an correcting bugs —I've spotted quite some already
  • Helping contributors/maintainers enforce contracts, with zero runtime impact to reusers
  • Finally, they're a just part of the standard core of Python, like using a list or concatenating a string

TODO

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:docs Add or improvement of documentation kind:roadmap A group of issues, constituting a delivery roadmap
Projects
Status: Roadmaps/Themes
Development

No branches or pull requests

1 participant