style: Add a comment about a Send bound that may look confusing.

servo · Sep 12, 2019 · 3fcd23d · 3fcd23d
1 parent c7add81
commit 3fcd23d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/components/style/scoped_tls.rs b/components/style/scoped_tls.rs
@@ -15,6 +15,9 @@ use std::ops::DerefMut;
 ///
 /// We use this on Servo to construct thread-local contexts, but clear them once
 /// we're done with restyling.
+///
+/// Note that the cleanup is done on the thread that owns the scoped TLS, thus
+/// the Send bound.
 pub struct ScopedTLS<'scope, T: Send> {
     pool: &'scope rayon::ThreadPool,
     slots: Box<[RefCell<Option<T>>]>,