-
Notifications
You must be signed in to change notification settings - Fork 111
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
ENH: introduce typing checking and GitHub workflow #6885
Conversation
Some simply do not have any type annotations, but some do have annotations and imports from typing, thus were selected for a "starter"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I cannot speak to the changes, but I think it would be good to add comments on this type of code too. Sooner are later these checks will start to fail, and at that point everyone is expected to know what is going on, what the purpose of a check is, and also where its intended scope is. From the action specification it is not at all obvious that this type-checking is limited to very few code pieces. This check passing, means very little about the quality and comprehensiveness of typing in datalad in general, but that message won't be that with the green checkmark in a PR.
@@ -0,0 +1,27 @@ | |||
name: Type-check |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In response to @mih #6885 (review) . Do you mean something like
name: Type-check | |
# This workflow is running types checks using `tox -e typing` you could do locally. | |
# As type hinting is not yet fully and consistently done through out the project only | |
# some selected files (listed in tox.ini) will be checked. Feel welcome to add extra | |
# files to the list there. See https://github.com/datalad/datalad/issues/6884 for the | |
# overall goal/progress towards type hints coverage in DataLad. | |
name: Type-check |
or what?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, we improved this wording a bit to signal that selection of initial files pretty much random. The point is to extend it.
Since this is better than nothing let's proceed
Codecov Report
@@ Coverage Diff @@
## maint #6885 +/- ##
==========================================
+ Coverage 90.25% 91.21% +0.95%
==========================================
Files 354 354
Lines 46116 46116
==========================================
+ Hits 41622 42064 +442
+ Misses 4494 4052 -442
Continue to review full report at Codecov.
|
52f1d83
to
48aeda5
Compare
Initiates work toward addressing #6884