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 documentation, tests, and automatic tools #57

Merged
merged 22 commits into from
Mar 18, 2024
Merged

Conversation

maurapintor
Copy link
Collaborator

@maurapintor maurapintor commented Mar 16, 2024

Changelog

  • Added ruff https://docs.astral.sh/ruff/
  • Removed black (replaced with Ruff)
  • Added pytest + codecov https://about.codecov.io
  • Lots of docstrings
  • Some fixes
  • Refactoring changes, mostly making private methods
  • Added pre-commit configuration
  • Added sphinx docs
  • Added conf file for readthedocs

Fixes #36 #54 , #55 , #56.

@maurapintor maurapintor added documentation Improvements or additions to documentation enhancement New feature or request refactoring Improvements that don't add or modify functionalities. labels Mar 16, 2024
@maurapintor maurapintor self-assigned this Mar 16, 2024
Copy link

codecov bot commented Mar 17, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@maurapintor maurapintor marked this pull request as ready for review March 17, 2024 21:07
@maurapintor maurapintor requested a review from zangobot March 17, 2024 21:10
@zangobot zangobot merged commit 82ee893 into main Mar 18, 2024
6 checks passed
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 enhancement New feature or request refactoring Improvements that don't add or modify functionalities.
Projects
None yet
2 participants