Skip to content

Commit

Permalink
Add a comment on timers on windows (#82)
Browse files Browse the repository at this point in the history
* Add a comment on timers on windows

Based on #80
  • Loading branch information
rabbbit committed Mar 31, 2022
1 parent 3550413 commit bf0eb9e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ func main() {
- What's the major diff v.s. https://pkg.go.dev/golang.org/x/time/rate? (based on #77)

This ratelimiter was meant to have a (1) simple API and (2) minimal overheard. For more complex use-cases [x/time/rate] is a great choice. See [here][redit] for historical context, and [here][bench] for benchmarks (from 2016).

- Why does example_test.go fail when I run it locally on Windows? (based on #80)

Windows has some known issues with timers precision. See golang/go#44343. We don't expect to work around it.

[cov-img]: https://codecov.io/gh/uber-go/ratelimit/branch/master/graph/badge.svg?token=zhLeUjjrm2
[cov]: https://codecov.io/gh/uber-go/ratelimit
Expand Down

0 comments on commit bf0eb9e

Please sign in to comment.