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

chore: add type hints and doctrings #45

Merged
merged 5 commits into from
Feb 26, 2025

Conversation

b8raoult
Copy link
Collaborator

@b8raoult b8raoult commented Feb 23, 2025

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Issue Number

Code Compatibility

  • I have performed a self-review of my code

Code Performance and Testing

  • I have added tests that prove my fix is effective or that my feature works
  • I ran the complete Pytest test suite locally, and they pass

Dependencies

  • I have ensured that the code is still pip-installable after the changes and runs
  • I have tested that new dependencies themselves are pip-installable.

Documentation

  • My code follows the style guidelines of this project
  • I have updated the documentation and docstrings to reflect the changes
  • I have added comments to my code, particularly in hard-to-understand areas

Additional Notes

floriankrb
floriankrb previously approved these changes Feb 24, 2025
floriankrb
floriankrb previously approved these changes Feb 26, 2025
@floriankrb floriankrb merged commit 98ac8d9 into main Feb 26, 2025
64 checks passed
@floriankrb floriankrb deleted the chore/types-hints-and-docstrings branch February 26, 2025 14:12
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 79.16667% with 5 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@4517227). Learn more about missing BASE report.

Files with missing lines Patch % Lines
tests/test_snow.py 20.00% 4 Missing ⚠️
tests/test_filters.py 87.50% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main      #45   +/-   ##
=======================================
  Coverage        ?   39.24%           
=======================================
  Files           ?        5           
  Lines           ?      158           
  Branches        ?        0           
=======================================
  Hits            ?       62           
  Misses          ?       96           
  Partials        ?        0           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD dependencies Pull requests that update a dependency file tests
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants