From e1a1b0aa83d33c65579006e03b6f8e9fd81783c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sarek=20H=C3=B8verstad=20Skot=C3=A5m?= Date: Sun, 29 Sep 2024 19:34:37 -0700 Subject: [PATCH] Fix doc-comments --- src/annotations/mod.rs | 6 +++--- src/lib.rs | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/annotations/mod.rs b/src/annotations/mod.rs index 14f2241..8768112 100644 --- a/src/annotations/mod.rs +++ b/src/annotations/mod.rs @@ -1,5 +1,5 @@ //! Annotated schedules. When an execution is scheduled using the -//! [`AnnotationScheduler`], Shuttle will produce a file that contains +//! [`crate::scheduler::AnnotationScheduler`], Shuttle will produce a file that contains //! additional information about the execution, such as the kind of step that //! was taken (was a task created, were permits acquired from a semaphore, etc) //! as well as the task's vector clocks and thus any causal dependence between @@ -464,9 +464,9 @@ cfg_if::cfg_if! { } /// Trait to record information about shared objects, such as their name and -/// type. See implementation in [`BatchSemaphore`], which actually records the +/// type. See implementation in [`crate::future::batch_semaphore::BatchSemaphore`], which actually records the /// name into the schedule, other types should forward calls into their -/// underlying primitive, as in [`Mutex`]. +/// underlying primitive, as in [`crate::sync::Mutex`]. pub trait WithName { /// Set the name and kind (full type path) of this object. fn with_name_and_kind(self, name: Option<&str>, kind: Option<&str>) -> Self; diff --git a/src/lib.rs b/src/lib.rs index 4cb5512..6d00478 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -435,7 +435,7 @@ where /// non-determinism other than that introduced by scheduling. /// /// This is a convenience function for constructing a [`Runner`] that uses -/// an [`AnnotationScheduler`] wrapping a replay scheduler created with +/// an [`crate::scheduler::AnnotationScheduler`] wrapping a replay scheduler created with /// [`ReplayScheduler::new_from_encoded`](scheduler::ReplayScheduler::new_from_encoded). pub fn annotate_replay(f: F, encoded_schedule: &str) where