From 78bbd5444d10cdc2de43d4b137fe3f7e776248b9 Mon Sep 17 00:00:00 2001 From: Carine Morel Date: Wed, 4 Dec 2024 13:50:55 +0100 Subject: [PATCH] Minor fixes in documentation. (#174) Minor fixes in documentation and test names. --- src/bounded_queue/bounded_queue_intf.mli | 2 +- src/treiber_stack.mli | 2 +- test/htbl/dscheck_htbl.ml | 4 ++-- test/skiplist/dscheck_skiplist.ml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/bounded_queue/bounded_queue_intf.mli b/src/bounded_queue/bounded_queue_intf.mli index 532b1d4f..03f1cacd 100644 --- a/src/bounded_queue/bounded_queue_intf.mli +++ b/src/bounded_queue/bounded_queue_intf.mli @@ -96,7 +96,7 @@ module type BOUNDED_QUEUE = sig (** {2 Producer functions} *) exception Full - (** Raised when {!push_exn} or {!push_all_exn} is applied to a full queue. *) + (** Raised when {!push_exn} is applied to a full queue. *) val push_exn : 'a t -> 'a -> unit (** [push_exn queue element] adds [element] at the end of the [queue]. diff --git a/src/treiber_stack.mli b/src/treiber_stack.mli index f0647ed4..4553e19b 100644 --- a/src/treiber_stack.mli +++ b/src/treiber_stack.mli @@ -20,7 +20,7 @@ val is_empty : 'a t -> bool (** {2 Consumer functions} *) exception Empty -(** Raised when {!pop_exn}, {!peek_exn}, {!drop_exn}, or {!set_exn} is +(** Raised when {!pop_exn}, {!peek_exn} and {!drop_exn} is applied to an empty stack. *) diff --git a/test/htbl/dscheck_htbl.ml b/test/htbl/dscheck_htbl.ml index 1088c245..138c9927 100644 --- a/test/htbl/dscheck_htbl.ml +++ b/test/htbl/dscheck_htbl.ml @@ -238,8 +238,8 @@ let () = if safe then let module Safe = Dscheck_htbl (Htbl) in let open Alcotest in - run "DSCheck Hshtbl" (Safe.tests "safe") + run "dscheck_htbl" (Safe.tests "safe") else let module Unsafe = Dscheck_htbl (Htbl_unsafe) in let open Alcotest in - run "DSCheck Hshtbl" (Unsafe.tests "unsafe") + run "dscheck_htbl_unsafe" (Unsafe.tests "unsafe") diff --git a/test/skiplist/dscheck_skiplist.ml b/test/skiplist/dscheck_skiplist.ml index 16a24362..7822ead4 100644 --- a/test/skiplist/dscheck_skiplist.ml +++ b/test/skiplist/dscheck_skiplist.ml @@ -102,7 +102,7 @@ let _two_remove () = let () = let open Alcotest in - run "DSCheck Skiplist" + run "DSCheck_Skiplist" [ ( "basic", [