From 958848e8ed10c7b8a83c9faea1fac6eaac39b018 Mon Sep 17 00:00:00 2001
From: mat <git@matdoes.dev>
Date: Tue, 24 Dec 2024 04:37:55 +0000
Subject: improve some docs and apis related to pathfinder

---
 azalea/src/bot.rs | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'azalea/src/bot.rs')

diff --git a/azalea/src/bot.rs b/azalea/src/bot.rs
index eee0f880..522f99eb 100644
--- a/azalea/src/bot.rs
+++ b/azalea/src/bot.rs
@@ -104,6 +104,11 @@ impl BotClientExt for azalea_client::Client {
         });
     }
 
+    /// Returns a Receiver that receives a message every game tick.
+    ///
+    /// This is useful if you want to efficiently loop until a certain condition
+    /// is met.
+    ///
     /// ```
     /// # use azalea::prelude::*;
     /// # use azalea::container::WaitingForInventoryOpen;
-- 
cgit v1.2.3