Closed devdanzin closed 1 year ago
Merging #198 (8d5d8d4) into master (2f59f94) will decrease coverage by
0.17%
. The diff coverage isn/a
.
@@ Coverage Diff @@
## master #198 +/- ##
==========================================
- Coverage 95.26% 95.10% -0.17%
==========================================
Files 23 23
Lines 1226 1226
Branches 276 276
==========================================
- Hits 1168 1166 -2
- Misses 33 34 +1
- Partials 25 26 +1
Impacted Files | Coverage Δ | |
---|---|---|
src/wily/__main__.py | 95.53% <ø> (ø) |
|
src/wily/cache.py | 98.18% <ø> (ø) |
|
src/wily/commands/build.py | 86.95% <ø> (-2.18%) |
:arrow_down: |
src/wily/commands/graph.py | 100.00% <ø> (ø) |
|
src/wily/commands/rank.py | 96.42% <ø> (ø) |
|
src/wily/commands/report.py | 97.08% <ø> (ø) |
|
src/wily/operators/__init__.py | 100.00% <ø> (ø) |
|
src/wily/operators/maintainability.py | 100.00% <ø> (ø) |
|
src/wily/state.py | 95.23% <ø> (ø) |
This library was written before type annotations were available in all versions of Python, so it makes sense at this stage to remove a lot of the docstring types and annotate the functions correctly then use mypy or pyright to do the validation.
For now, I'll bring this one in, thanks for the update
Fix some docstrings for correct description, typos, typing information, consistency, etc.
For typing information, the docstring was updated to what is in code, but we could instead fix the code where it makes sense: e.g. when the docstring expects a the name of the Archiver (a str) but an Archiver is passed instead, we could actually pass the name. I'm willing to fix it either way.