golang/go

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

Open

#54,082 创建于 2022年7月27日

在 GitHub 查看
 (9 评论) (1 反应) (0 负责人)Go (19,008 fork)batch import
DocumentationNeedsInvestigationhelp wanted

仓库指标

Star
 (133,883 star)
PR 合并指标
 (30 天内没有已合并 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
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Go
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90