Skip to content

Commit

Permalink
Fix peek -> peek_exn in doc. (#148)
Browse files Browse the repository at this point in the history
  • Loading branch information
lyrm authored Aug 22, 2024
1 parent 60dd353 commit fe0b79c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src_lockfree/michael_scott_queue_intf.ml
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ module type MS_QUEUE = sig
(** [push q v] adds the element [v] at the end of the queue [q]. *)

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

val pop_exn : 'a t -> 'a
(** [pop q] removes and returns the first element in queue [q].
(** [pop_exn q] removes and returns the first element in queue [q].
@raise Empty if [q] is empty. *)

Expand All @@ -51,7 +51,7 @@ module type MS_QUEUE = sig
returns [None] if the queue is empty. *)

val peek_exn : 'a t -> 'a
(** [peek q] returns the first element in queue [q].
(** [peek_exn q] returns the first element in queue [q].
@raise Empty if [q] is empty. *)

Expand Down

0 comments on commit fe0b79c

Please sign in to comment.