minor #17869 [RateLimiter] Adding reset() (ThomasLandauer)

javiereguiluz · javiereguiluz · commit 21eff3cd842e · 2023-02-06T10:02:53.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [RateLimiter] Adding `reset()` Page: https://symfony.com/doc/5.4/rate_limiter.html#rate-limiting-in-action Wasn't mentioned anywhere... Commits ------- fc18449 Adding `reset()`
diff --git a/rate_limiter.rst b/rate_limiter.rst
@@ -249,10 +249,11 @@ the number of requests to the API::
             // RateLimitExceededException if the limit has been reached
             // $limiter->consume(1)->ensureAccepted();
 
+            // to reset the counter
+            // $limiter->reset();
+
             // ...
         }
-
-        // ...
     }
 
 .. note::

Original file line number	Diff line number	Diff line change
`@@ -249,10 +249,11 @@ the number of requests to the API::`
`249`	`249`	`// RateLimitExceededException if the limit has been reached`
`250`	`250`	`// $limiter->consume(1)->ensureAccepted();`
`251`	`251`
	`252`	`+ // to reset the counter`
	`253`	`+ // $limiter->reset();`
	`254`	`+`
`252`	`255`	`// ...`
`253`	`256`	`}`
`254`		`-`
`255`		`- // ...`
`256`	`257`	`}`
`257`	`258`
`258`	`259`	`.. note::`