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

[DOC] Add flake8-docstrings and adapt the docstring and typing to it #159

Merged
merged 1 commit into from
Jul 7, 2022

Conversation

tobiasah
Copy link
Member

@tobiasah tobiasah commented Jul 7, 2022

Description:
Add https://pypi.org/project/flake8-docstrings/ to the lint step.

Also fix some typehints from #136

@codecov
Copy link

codecov bot commented Jul 7, 2022

Codecov Report

Merging #159 (992510d) into main (3a51c81) will decrease coverage by 0.00%.
The diff coverage is 97.22%.

@@            Coverage Diff             @@
##             main     #159      +/-   ##
==========================================
- Coverage   98.83%   98.82%   -0.01%     
==========================================
  Files          34       34              
  Lines        2233     2130     -103     
==========================================
- Hits         2207     2105     -102     
+ Misses         26       25       -1     
Impacted Files Coverage Δ
src/zhinst/toolkit/command_table.py 98.79% <ø> (ø)
src/zhinst/toolkit/driver/devices/hdawg.py 100.00% <ø> (ø)
src/zhinst/toolkit/driver/devices/shfqa.py 97.95% <ø> (ø)
src/zhinst/toolkit/driver/devices/shfsg.py 98.03% <ø> (ø)
src/zhinst/toolkit/driver/modules/__init__.py 100.00% <ø> (ø)
...rc/zhinst/toolkit/driver/modules/sweeper_module.py 95.00% <ø> (ø)
src/zhinst/toolkit/driver/nodes/shfqa_scope.py 100.00% <ø> (ø)
src/zhinst/toolkit/driver/nodes/spectroscopy.py 100.00% <ø> (ø)
src/zhinst/toolkit/interface.py 100.00% <ø> (ø)
src/zhinst/toolkit/nodetree/node.py 99.30% <ø> (ø)
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3a51c81...992510d. Read the comment docs.

@tobiasah tobiasah mentioned this pull request Jul 7, 2022
19 tasks
@tobiasah tobiasah requested a review from markheik July 7, 2022 07:10
@tobiasah tobiasah added the documentation Improvements or additions to documentation label Jul 7, 2022
@tobiasah tobiasah self-assigned this Jul 7, 2022
@tobiasah tobiasah merged commit 26eff06 into main Jul 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants