Skip to content

Commit

Permalink
Fix doc-comments
Browse files Browse the repository at this point in the history
  • Loading branch information
sarsko committed Sep 30, 2024
1 parent 9a5f91d commit e1a1b0a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions src/annotations/mod.rs
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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: F, encoded_schedule: &str)
where
Expand Down

0 comments on commit e1a1b0a

Please sign in to comment.