Skip to content

Commit

Permalink
fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
lyrm committed Nov 24, 2024
1 parent dcc3298 commit 2d1970d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/spsc_queue/spsc_queue_intf.mli
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module type SPSC_queue = sig

type 'a t
(** Represents a single-producer single-consumer non-resizable queue
that works in FIFO order. *)
that works in FIFO order. *)

val create : size_exponent:int -> 'a t
(** [create ~size_exponent:int] creates a new single-producer single-consumer
Expand All @@ -29,8 +29,8 @@ module type SPSC_queue = sig

val length : 'a t -> int
(** [length] returns the length of the queue. This method linearizes only when
called from either the consumer or producer domain. Otherwise, it is safe to
call but provides only an *indication* of the size of the structure. *)
called from either the consumer or producer domain. Otherwise, it is safe to
call but provides only an *indication* of the size of the structure. *)

(** {2 Producer functions} *)

Expand All @@ -52,11 +52,11 @@ module type SPSC_queue = sig

exception Empty
(** Raised when {!pop_exn}, {!peek_exn}, or {!drop_exn} is applied to an empty
queue. *)
queue. *)

val pop_exn : 'a t -> 'a
(** [pop_exn queue] removes and returns the first element in [queue]. This
method can be used by at most one domain at a time.
method can be used by at most one domain at a time.
@raises Empty if the [queue] is empty. *)

Expand All @@ -67,7 +67,7 @@ module type SPSC_queue = sig

val peek_exn : 'a t -> 'a
(** [peek_exn queue] returns the first element in [queue] without removing it.
This method can be used by at most one domain at a time.
This method can be used by at most one domain at a time.
@raises Empty if the [queue] is empty. *)

Expand Down

0 comments on commit 2d1970d

Please sign in to comment.