Skip to content

Improve docs#20

Merged
ahmadtourei merged 2 commits intomainfrom
improve_docs
Dec 10, 2025
Merged

Improve docs#20
ahmadtourei merged 2 commits intomainfrom
improve_docs

Conversation

@ahmadtourei
Copy link
Collaborator

@ahmadtourei ahmadtourei commented Dec 10, 2025

This PR improves the readme and utils.py docs and adds a few example notebooks and bash scripts.

@codecov
Copy link

codecov bot commented Dec 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@9730bd8). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #20   +/-   ##
=======================================
  Coverage        ?   83.18%           
=======================================
  Files           ?       13           
  Lines           ?      791           
  Branches        ?        0           
=======================================
  Hits            ?      658           
  Misses          ?      133           
  Partials        ?        0           
Flag Coverage Δ
python-3.10 83.18% <100.00%> (?)
python-3.11 83.18% <100.00%> (?)
python-3.12 83.18% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ahmadtourei ahmadtourei merged commit dfd1cbc into main Dec 10, 2025
20 checks passed
@ahmadtourei ahmadtourei deleted the improve_docs branch December 10, 2025 22:29
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.

1 participant