Skip to content

Commit da601ba

Browse files
author
Tamio-Vesa Nakajima
committed
Typographical error fixes for rate_limiter
Signed-off-by: Tamio-Vesa Nakajima <[email protected]>
1 parent a7201fb commit da601ba

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

rate_limiter/src/lib.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,9 @@ impl fmt::Debug for RateLimiter {
281281
}
282282

283283
impl RateLimiter {
284-
// description
284+
/// This function creates a `TokenBucket` wrapped in an `Option` with a given total capacity,
285+
/// one time burst, and complete refill time (in miliseconds). If the total capacity or the
286+
/// complete refill time are zero, then `None` is returned.
285287
fn make_bucket(
286288
total_capacity: u64,
287289
one_time_burst: Option<u64>,
@@ -426,7 +428,7 @@ impl RateLimiter {
426428
}
427429

428430
/// Updates the parameters of the token buckets associated with this RateLimiter.
429-
// TODO: Pls note that, right now, the buckets become full after being updated.
431+
// TODO: Please note that, right now, the buckets become full after being updated.
430432
pub fn update_buckets(&mut self, bytes: Option<TokenBucket>, ops: Option<TokenBucket>) {
431433
// TODO: We should reconcile the create and update paths, such that they use the same data
432434
// format. Currently, the TokenBucket config data is used for create, but the live

0 commit comments

Comments
 (0)