rate: fix documentation of Limiter.ReserveN()

Update documentation string to mention that the returned
Reservation's OK() method returns false if n exceeds the
Limiter's burst size.

Fixes golang/go#38434

Change-Id: Ic549100189caad2ae6cda8379bfd8fa04b02c415
Reviewed-on: https://go-review.googlesource.com/c/time/+/228357
Run-TryBot: Andrew Bonventre <andybons@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Andrew Bonventre <andybons@golang.org>
1 file changed
tree: fa3b5626a6dc0184d609e25043ff605ba33ebad6
  1. rate/
  2. AUTHORS
  3. CONTRIBUTING.md
  4. CONTRIBUTORS
  5. go.mod
  6. LICENSE
  7. PATENTS
  8. README.md
README.md

Go Time

This repository provides supplementary Go time packages.

Download/Install

The easiest way to install is to run go get -u golang.org/x/time. You can also manually git clone the repository to $GOPATH/src/golang.org/x/time.

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.

The main issue tracker for the time repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/time:” in the subject line, so it is easy to find.