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

Add type hints (Part 2) #679

Merged
merged 8 commits into from
Feb 2, 2024
Merged

Add type hints (Part 2) #679

merged 8 commits into from
Feb 2, 2024

Conversation

desilinguist
Copy link
Member

@desilinguist desilinguist commented Feb 1, 2024

Changes

  • Minor typos in docstrings.
  • Add sphinx-autodoc-typehints dependency.
  • Improve sphinx auto documentation.
  • Add type hints to container.py
  • Add type hints to analyzer.py
  • Add type hints to comparer.py.
  • Add type hints to configuration_parser.py

To review

  • Please check that I have not left any parameters/arguments/return values without type hints.
  • Here's the RTD build for this branch. Check the "API Documentation" section (only for the files affected by this MR and the previous one) to confirm that all types are linked to relevant pages from external documentations (e.g., Python, Numpy, SKLL). There's no W&B yet since it doesn't seem to work. I have a ticket open with them.
  • Check for typos and/or weird issues in docstrings.

Copy link

codecov bot commented Feb 1, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (519d3ea) 96.13% compared to head (8d50bd3) 96.14%.

Files Patch % Lines
rsmtool/container.py 93.93% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #679   +/-   ##
=======================================
  Coverage   96.13%   96.14%           
=======================================
  Files          32       32           
  Lines        4473     4483   +10     
=======================================
+ Hits         4300     4310   +10     
  Misses        173      173           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

rsmtool/analyzer.py Outdated Show resolved Hide resolved
rsmtool/comparer.py Outdated Show resolved Hide resolved
rsmtool/container.py Outdated Show resolved Hide resolved
rsmtool/container.py Outdated Show resolved Hide resolved
@desilinguist desilinguist merged commit 8ee9dbf into main Feb 2, 2024
10 checks passed
@delete-merged-branch delete-merged-branch bot deleted the 326-type-hints-2 branch February 2, 2024 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants