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

Rewrite strategy documentation to improve correctness #254

Merged
merged 2 commits into from
Mar 6, 2025

Conversation

alisaifee
Copy link
Owner

@alisaifee alisaifee commented Mar 3, 2025

Description

  • Remove ambiguity around window start/end for fixed windows
  • Add consistent & concrete examples for all strategies
  • Update README to be in sync with rtd documentation

Related issue: #250
Read the docs: https://limits.readthedocs.io/en/strategy-doc-revision/strategies.html

@alisaifee alisaifee force-pushed the strategy-doc-revision branch 2 times, most recently from ea8a352 to 59f87a4 Compare March 3, 2025 20:13
Copy link

codecov bot commented Mar 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.31%. Comparing base (cdca682) to head (d9f95ad).
Report is 8 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #254   +/-   ##
=======================================
  Coverage   93.31%   93.31%           
=======================================
  Files          25       25           
  Lines        1586     1586           
  Branches      144      144           
=======================================
  Hits         1480     1480           
  Misses         76       76           
  Partials       30       30           

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

- Remove ambiguity around window start/end for fixed windows
- Add consistent scenarios for all strategies
@alisaifee alisaifee force-pushed the strategy-doc-revision branch from 59f87a4 to 5573d65 Compare March 4, 2025 01:20
@alisaifee alisaifee marked this pull request as ready for review March 4, 2025 01:22
@alisaifee
Copy link
Owner Author

@mje-nz if you'd like to take a quick look.

@alisaifee
Copy link
Owner Author

cc @Merinorus just FYI since I made some tweaks to the sliding window strategy docs as well.

@alisaifee alisaifee linked an issue Mar 5, 2025 that may be closed by this pull request
@alisaifee
Copy link
Owner Author

I'll merge this for now since it should certainly be more accurate than before. If you have any suggestions for improvements please do let me know.

@alisaifee alisaifee merged commit f397729 into master Mar 6, 2025
35 checks passed
@alisaifee alisaifee deleted the strategy-doc-revision branch March 6, 2025 18:44
@Merinorus
Copy link
Contributor

That's more clear, with a practical example. Thank you!

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.

Misleading docs
2 participants