diff --git a/src/progress_bar.rs b/src/progress_bar.rs index f2e85725..ae6cff77 100644 --- a/src/progress_bar.rs +++ b/src/progress_bar.rs @@ -618,8 +618,15 @@ impl ProgressBar { self.state().state.elapsed() } - /// Index in the `MultiState` - pub(crate) fn index(&self) -> Option { + /// Opaque index in the `MultiState`. + /// + /// This value is an implementation detail and does not necessarily correspond to visual + /// position on the screen. + /// + /// It is an index into `MultiState::members`, which is not in any particular order (due to + /// reclaiming of indices from the `MultiState::free_set`). + #[doc(hidden)] + pub fn index(&self) -> Option { self.state().draw_target.remote().map(|(_, idx)| idx) }