Skip to content

Commit b6abd6d

Browse files
ndmitchellfacebook-github-bot
authored andcommitted
Improve documentation
Summary: #126 (comment) points out this was incorrect. Fix the docs. Reviewed By: JakobDegen Differential Revision: D61794505 fbshipit-source-id: e5b97755c33d2b98d9719686a997a0ae5139a868
1 parent 2ebc8be commit b6abd6d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

starlark/src/values/traits.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,9 @@ where
197197
/// Every Rust value stored in a [`Value`] must implement this trait.
198198
/// You _must_ also implement [`ComplexValue`] if:
199199
///
200-
/// * A type is _mutable_, if you ever need to get a `&mut self` reference to it.
201-
/// * A type _contains_ nested Starlark [`Value`]s.
200+
/// * A type is not [`Send`] and [`Sync`], typically because it contains
201+
/// interior mutability such as a [`RefCell`](std::cell::RefCell).
202+
/// * A type contains nested Starlark [`Value`]s.
202203
///
203204
/// There are only two required members of [`StarlarkValue`], namely
204205
/// [`TYPE`](StarlarkValue::TYPE)

0 commit comments

Comments
 (0)