Apply suggestions from code review

Co-authored-by: Eliza Weisman <[email protected]>
hawkw · Jul 7, 2024 · 312b5e5 · 312b5e5
1 parent 91b0405
commit 312b5e5
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/maitake-sync/src/wait_queue.rs b/maitake-sync/src/wait_queue.rs
@@ -692,8 +692,10 @@ impl WaitQueue {
     ///
     /// Consider using [`Self::wait_for_value()`] if your function does return a value.
     ///
-    /// * Returns `Ok(())` if the closure returns `true`.
-    /// * Returns `Err(Closed)` if the [`WaitQueue`] is closed.
+    /// # Returns
+    ///
+    /// * [`Ok`]`(())` if the closure returns `true`.
+    /// * [`Err`]`(`[`Closed`]`)` if the [`WaitQueue`] is closed.
     pub async fn wait_for<F: FnMut() -> bool>(&self, mut f: F) -> WaitResult<()> {
         loop {
             let wait = self.wait();