golang/go

x/time/rate: document the behavior of negative n

Open

#54,082 opened on 2022年7月27日

GitHub で見る
 (9 comments) (1 reaction) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

The methods AllowN, ReserveN, WaitN take in a user-specified number of tokens to take. The documentation does not specify what happens when the number of tokens is negative.

Without digging into the details, it appears that you can actually specify a negative n, in which case it returns that number of tokens to the rate limiter.

コントリビューターガイド

調査方針
rateパッケージのAllowN、ReserveN、WaitNのソースコードを読み、nが負のときの動作を確認し、ドキュメントを更新してください。
技術スタック
go
領域
backend
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Go
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90