Skip to content

Conversation

@desilinguist
Copy link
Collaborator

@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.

@codecov
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.

@desilinguist desilinguist merged commit 8ee9dbf into main Feb 2, 2024
@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.

4 participants