tree fa3b5626a6dc0184d609e25043ff605ba33ebad6
parent 555d28b269f0569763d25dbe1a237ae74c6bcc82
author Obeyda Djeffal <djefobey@gmail.com> 1586974259 +0100
committer Andrew Bonventre <andybons@golang.org> 1587013931 +0000

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>