Merge pull request #2848 from jannic/pio_pull_doc_improvement

Add a comment to the pio rx fifo pull function

1 files changed, 4 insertions, 0 deletions

diff --git a/embassy-rp/src/pio/mod.rs b/embassy-rp/src/pio/mod.rs
index 2e5c57a26..1f7adbda3 100644
--- a/embassy-rp/src/pio/mod.rs
+++ b/embassy-rp/src/pio/mod.rs
@@ -324,6 +324,10 @@ impl<'d, PIO: Instance, const SM: usize> StateMachineRx<'d, PIO, SM> {
     }
 
     /// Pull data from RX FIFO.
+    ///
+    /// This function doesn't check if there is data available to be read.
+    /// If the rx FIFO is empty, an undefined value is returned. If you only
+    /// want to pull if data is available, use `try_pull` instead.
     pub fn pull(&mut self) -> u32 {
         PIO::PIO.rxf(SM).read()
     }