Merge pull request #8 from esden/location-track-docstring

Added card.location.track docstring
gauteh · Dec 31, 2023 · 1f3cf9f · 1f3cf9f
2 parents 44e7fc6 + 72aa186
commit 1f3cf9f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/card.rs b/src/card.rs
@@ -70,6 +70,8 @@ impl<'a, IOM: Write<SevenBitAddress> + Read<SevenBitAddress>, const BS: usize> C
         Ok(FutureResponse::from(self.note))
     }
 
+    /// Store location data in a Notefile at the `periodic` interval, or using specified `heartbeat`.
+    /// Only available when `card.location.mode` has been set to `periodic`.
     pub fn location_track(
         self,
         delay: &mut impl DelayMs<u16>,