core: `iter_render_list` returns a non-locking iterator and should be documented as such.

This commit is contained in:
David Wendt 2021-01-16 15:52:28 -05:00 committed by Mike Welsh
parent 094563e28f
commit 5acaf0bd01
1 changed files with 6 additions and 2 deletions

View File

@ -219,9 +219,13 @@ pub trait TDisplayObjectContainer<'gc>:
/// Iterates over the children of this display object in render order. This
/// is different than execution or depth order.
///
/// This yields an iterator that *does* lock the parent and cannot be
/// This yields an iterator that does *not* lock the parent and can be
/// safely held in situations where display objects need to be unlocked.
/// It's concrete type is stated here due to Rust language limitations.
/// This means that unexpected but legal and defined items may be yielded
/// due to intended or unintended list manipulation by the caller.
///
/// The iterator's concrete type is stated here due to Rust language
/// limitations.
fn iter_render_list(self) -> RenderIter<'gc> {
RenderIter::from_container(self.into())
}