Rollup merge of #104708 - jonasspinner:fix-backoff-doc-to-match-implementation, r=compiler-errors

fee1-dead · web-flow · commit 5b7612a76714 · 2022-12-28T15:51:40.000+08:00
Fix backoff doc to match implementation

The commit 8dddb2294310ad3e8ce0b2af735a702ad72a9a99 in the crossbeam-channel PR (#93563) changed the backoff strategy to be quadratic instead of exponential. This updates the doc to prevent confusion.
diff --git a/std/src/sync/mpmc/utils.rs b/std/src/sync/mpmc/utils.rs
@@ -136,7 +136,7 @@ impl Backoff {
         }
     }
 
-    /// Returns `true` if exponential backoff has completed and blocking the thread is advised.
+    /// Returns `true` if quadratic backoff has completed and blocking the thread is advised.
     #[inline]
     pub fn is_completed(&self) -> bool {
         self.step.get() > YIELD_LIMIT

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ impl Backoff {`
`136`	`136`	`}`
`137`	`137`	`}`
`138`	`138`
`139`		- /// Returns `true` if exponential backoff has completed and blocking the thread is advised.
	`139`	+ /// Returns `true` if quadratic backoff has completed and blocking the thread is advised.
`140`	`140`	`#[inline]`
`141`	`141`	`pub fn is_completed(&self) -> bool {`
`142`	`142`	`self.step.get() > YIELD_LIMIT`