From 822eaabec01441b626ae6874aa9897843b9a69a1 Mon Sep 17 00:00:00 2001
From: datdenkikniet <jcdra1@gmail.com>
Date: Thu, 13 Apr 2023 18:42:48 +0200
Subject: rtic-time: Docs

---
 rtic-time/src/linked_list.rs | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'rtic-time/src/linked_list.rs')

diff --git a/rtic-time/src/linked_list.rs b/rtic-time/src/linked_list.rs
index c2a9967..b84b92d 100644
--- a/rtic-time/src/linked_list.rs
+++ b/rtic-time/src/linked_list.rs
@@ -1,11 +1,12 @@
-//! ...
-
 use core::marker::PhantomPinned;
 use core::pin::Pin;
 use core::sync::atomic::{AtomicPtr, Ordering};
 use critical_section as cs;
 
-/// A sorted linked list for the timer queue.
+/// An atomic sorted linked list for the timer queue.
+///
+/// Atomicity is guaranteed using very short [`critical_section`]s, so this list is _not_
+/// lock free, but it will not deadlock.
 pub(crate) struct LinkedList<T> {
     head: AtomicPtr<Link<T>>,
 }
-- 
cgit v1.2.3