rate_limiter: fix documentation indentation

Signed-off-by: Wei Liu <liuwe@microsoft.com>
This commit is contained in:
Wei Liu 2024-06-12 15:26:03 +00:00 committed by Bo Chen
parent 9f969ee18d
commit 9cd214b0a1

View File

@ -307,14 +307,14 @@ impl RateLimiter {
/// ///
/// * `bytes_total_capacity` - the total capacity of the `TokenType::Bytes` token bucket. /// * `bytes_total_capacity` - the total capacity of the `TokenType::Bytes` token bucket.
/// * `bytes_one_time_burst` - initial extra credit on top of `bytes_total_capacity`, /// * `bytes_one_time_burst` - initial extra credit on top of `bytes_total_capacity`,
/// that does not replenish and which can be used for an initial burst of data. /// that does not replenish and which can be used for an initial burst of data.
/// * `bytes_complete_refill_time_ms` - number of milliseconds for the `TokenType::Bytes` /// * `bytes_complete_refill_time_ms` - number of milliseconds for the `TokenType::Bytes`
/// token bucket to go from zero Bytes to `bytes_total_capacity` Bytes. /// token bucket to go from zero Bytes to `bytes_total_capacity` Bytes.
/// * `ops_total_capacity` - the total capacity of the `TokenType::Ops` token bucket. /// * `ops_total_capacity` - the total capacity of the `TokenType::Ops` token bucket.
/// * `ops_one_time_burst` - initial extra credit on top of `ops_total_capacity`, /// * `ops_one_time_burst` - initial extra credit on top of `ops_total_capacity`,
/// that does not replenish and which can be used for an initial burst of data. /// that does not replenish and which can be used for an initial burst of data.
/// * `ops_complete_refill_time_ms` - number of milliseconds for the `TokenType::Ops` token /// * `ops_complete_refill_time_ms` - number of milliseconds for the `TokenType::Ops` token
/// bucket to go from zero Ops to `ops_total_capacity` Ops. /// bucket to go from zero Ops to `ops_total_capacity` Ops.
/// ///
/// If either bytes/ops *size* or *refill_time* are **zero**, the limiter /// If either bytes/ops *size* or *refill_time* are **zero**, the limiter
/// is **disabled** for that respective token type. /// is **disabled** for that respective token type.