Skip to content

Conversation

aaelony
Copy link

@aaelony aaelony commented Oct 7, 2025

The USAGE section in the existing README.md didn't compile. Why? Because the settings code needs to be in a function scope, e.g. main. A simple fix ;)

This PR provides that simple fix, allowing causal users to find working code in the USAGE section.

@williambdean williambdean requested a review from aseyboldt October 7, 2025 21:21
@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.09%. Comparing base (394c629) to head (e2e9304).
⚠️ Report is 78 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (394c629) and HEAD (e2e9304). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (394c629) HEAD (e2e9304)
2 1
Additional details and impacted files
@@             Coverage Diff             @@
##             main      #40       +/-   ##
===========================================
- Coverage   83.77%   61.09%   -22.68%     
===========================================
  Files           8       27       +19     
  Lines        1923     6429     +4506     
===========================================
+ Hits         1611     3928     +2317     
- Misses        312     2501     +2189     

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

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.

2 participants