Skip to content

Commit

Permalink
docs: newer odoc opens Stdlib by default
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia committed Apr 29, 2022
1 parent 7b4f9e2 commit dbb4698
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion bwd.opam
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ depends: [
"dune" {>= "2.0"}
"ocaml" {>= "4.12"}
"qcheck-core" {>= "0.18" & with-test}
"odoc" {with-doc}
"odoc" {>= "2.0" & with-doc}
]
build: [
["dune" "build" "-p" name "-j" jobs]
Expand Down
12 changes: 6 additions & 6 deletions src/BwdLabels.mli
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(**
This module is similar to {!module:Stdlib.ListLabels} but for backward lists.
This module is similar to {!module:ListLabels} but for backward lists.
Notes on the discrepancies with {!module:Stdlib.ListLabels}:
Notes on the discrepancies with {!module:ListLabels}:
{ul
{- Functions [rev], [rev_append], [rev_map], and [rev_map2] will {i never} be included.}
{- A new function {!val:prepend} was added as the {i forward} version of {!val:append}.}
Expand Down Expand Up @@ -34,7 +34,7 @@ val compare : cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int
(** {1 Iterators}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.ListLabels}.
in the opposite direction of the corresponding functions in {!module:ListLabels}.
*)

val iter : f:('a -> unit) -> 'a t -> unit
Expand All @@ -49,7 +49,7 @@ val fold_right : f:('a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
(** {1 Iterators on two lists}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.ListLabels}.
in the opposite direction of the corresponding functions in {!module:ListLabels}.
*)

val iter2 : f:('a -> 'b -> unit) -> 'a t -> 'b t -> unit
Expand All @@ -60,7 +60,7 @@ val fold_right2 : f:('a -> 'b -> 'c -> 'c) -> 'a t -> 'b t -> init:'c -> 'c
(** {1 List scanning}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.ListLabels}.
in the opposite direction of the corresponding functions in {!module:ListLabels}.
*)

val for_all : f:('a -> bool) -> 'a t -> bool
Expand All @@ -73,7 +73,7 @@ val memq : 'a -> set:'a t -> bool
(** {1 List searching}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.ListLabels}.
in the opposite direction of the corresponding functions in {!module:ListLabels}.
*)

val find : f:('a -> bool) -> 'a t -> 'a
Expand Down
12 changes: 6 additions & 6 deletions src/BwdNoLabels.mli
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
(** @canonical Bwd.Bwd *)

(**
This module is similar to {!module:Stdlib.List} but for backward lists.
This module is similar to {!module:List} but for backward lists.
Notes on the discrepancies with {!module:Stdlib.List}:
Notes on the discrepancies with {!module:List}:
{ul
{- Functions [rev], [rev_append], [rev_map], and [rev_map2] will {i never} be included.}
{- A new function {!val:prepend} was added as the {i forward} version of {!val:append}.}
Expand Down Expand Up @@ -36,7 +36,7 @@ val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
(** {1 Iterators}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.List}.
in the opposite direction of the corresponding functions in {!module:List}.
*)

val iter : ('a -> unit) -> 'a t -> unit
Expand All @@ -51,7 +51,7 @@ val fold_right : ('a -> 'b -> 'b) -> 'a t -> 'b -> 'b
(** {1 Iterators on two lists}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.List}.
in the opposite direction of the corresponding functions in {!module:List}.
*)

val iter2 : ('a -> 'b -> unit) -> 'a t -> 'b t -> unit
Expand All @@ -62,7 +62,7 @@ val fold_right2 : ('a -> 'b -> 'c -> 'c) -> 'a t -> 'b t -> 'c -> 'c
(** {1 List scanning}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.List}.
in the opposite direction of the corresponding functions in {!module:List}.
*)

val for_all : ('a -> bool) -> 'a t -> bool
Expand All @@ -75,7 +75,7 @@ val memq : 'a -> 'a t -> bool
(** {1 List searching}
Note that the iteration direction is from the right to the left,
in the opposite direction of the corresponding functions in {!module:Stdlib.List}.
in the opposite direction of the corresponding functions in {!module:List}.
*)

val find : ('a -> bool) -> 'a t -> 'a
Expand Down

0 comments on commit dbb4698

Please sign in to comment.