Skip to content

Commit

Permalink
Merge pull request #6 from n-osborne/typos
Browse files Browse the repository at this point in the history
Fix a few typos
  • Loading branch information
talex5 committed Nov 1, 2023
2 parents 66a569e + e39b26e commit 9a45c5d
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/lwt_dllist.mli
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ val get : 'a node -> 'a
(** Returns the contents of a node *)

val set : 'a node -> 'a -> unit
(** Change the contents of a node *)
(** Changes the contents of a node *)

val remove : 'a node -> unit
(** Removes a node from the sequence it is part of. It does nothing
Expand All @@ -40,36 +40,36 @@ val is_empty : 'a t -> bool
(** Returns [true] iff the given sequence is empty *)

val length : 'a t -> int
(** Returns the number of elemenets in the given sequence. This is a
(** Returns the number of elements in the given sequence. This is a
O(n) operation where [n] is the number of elements in the
sequence. *)

val add_l : 'a -> 'a t -> 'a node
(** [add_l x s] adds [x] to the left of the sequence [s] *)

val add_r : 'a -> 'a t -> 'a node
(** [add_l x s] adds [x] to the right of the sequence [s] *)
(** [add_r x s] adds [x] to the right of the sequence [s] *)

exception Empty
(** Exception raised by [take_l] and [tale_s] and when the sequence
(** Exception raised by [take_l] and [take_r] and when the sequence
is empty *)

val take_l : 'a t -> 'a
(** [take_l x s] remove and returns the leftmost element of [s]
(** [take_l x s] removes and returns the leftmost element of [s]
@raise Empty if the sequence is empty *)

val take_r : 'a t -> 'a
(** [take_l x s] remove and returns the rightmost element of [s]
(** [take_l x s] removes and returns the rightmost element of [s]
@raise Empty if the sequence is empty *)

val take_opt_l : 'a t -> 'a option
(** [take_opt_l x s] remove and returns [Some x] where [x] is the
(** [take_opt_l x s] removes and returns [Some x] where [x] is the
leftmost element of [s] or [None] if [s] is empty *)

val take_opt_r : 'a t -> 'a option
(** [take_opt_l x s] remove and returns [Some x] where [x] is the
(** [take_opt_l x s] removes and returns [Some x] where [x] is the
rightmost element of [s] or [None] if [s] is empty *)

val transfer_l : 'a t -> 'a t -> unit
Expand Down

0 comments on commit 9a45c5d

Please sign in to comment.