diff options
author | Fardale <fardale+git@crans.org> | 2022-09-23 10:39:39 +0200 |
---|---|---|
committer | Fardale <fardale+git@crans.org> | 2022-09-23 10:40:41 +0200 |
commit | 174b00c8ac5a15c6fbdeccd08ffb1152433b81da (patch) | |
tree | 0f009ef46f5fdc47de1c07dfd43545023dfc97aa | |
parent | 889102d4f35545d7c460f4b73daf128e166bff2f (diff) | |
download | ocaml-174b00c8ac5a15c6fbdeccd08ffb1152433b81da.tar.gz |
documentation: fixed labelled arguments
Apply the change in 3f77c959b to the rest of the stdlib
-rw-r--r-- | stdlib/bytes.mli | 4 | ||||
-rw-r--r-- | stdlib/bytesLabels.mli | 4 | ||||
-rw-r--r-- | stdlib/hashtbl.mli | 12 | ||||
-rw-r--r-- | stdlib/moreLabels.mli | 12 | ||||
-rw-r--r-- | stdlib/templates/hashtbl.template.mli | 12 |
5 files changed, 22 insertions, 22 deletions
diff --git a/stdlib/bytes.mli b/stdlib/bytes.mli index 6566966c93..fd614bad75 100644 --- a/stdlib/bytes.mli +++ b/stdlib/bytes.mli @@ -316,14 +316,14 @@ val equal: t -> t -> bool val starts_with : prefix (* comment thwarts tools/sync_stdlib_docs *) :bytes -> bytes -> bool -(** [starts_with ][~][prefix s] is [true] if and only if [s] starts with +(** [starts_with ][~prefix s] is [true] if and only if [s] starts with [prefix]. @since 4.13.0 *) val ends_with : suffix (* comment thwarts tools/sync_stdlib_docs *) :bytes -> bytes -> bool -(** [ends_with suffix s] is [true] if and only if [s] ends with [suffix]. +(** [ends_with ][~suffix s] is [true] if and only if [s] ends with [suffix]. @since 4.13.0 *) diff --git a/stdlib/bytesLabels.mli b/stdlib/bytesLabels.mli index b40551a57f..b59374d460 100644 --- a/stdlib/bytesLabels.mli +++ b/stdlib/bytesLabels.mli @@ -316,14 +316,14 @@ val equal: t -> t -> bool val starts_with : prefix (* comment thwarts tools/sync_stdlib_docs *) :bytes -> bytes -> bool -(** [starts_with ][~][prefix s] is [true] if and only if [s] starts with +(** [starts_with ][~prefix s] is [true] if and only if [s] starts with [prefix]. @since 4.13.0 *) val ends_with : suffix (* comment thwarts tools/sync_stdlib_docs *) :bytes -> bytes -> bool -(** [ends_with suffix s] is [true] if and only if [s] ends with [suffix]. +(** [ends_with ][~suffix s] is [true] if and only if [s] ends with [suffix]. @since 4.13.0 *) diff --git a/stdlib/hashtbl.mli b/stdlib/hashtbl.mli index 9d8e9055ec..111776ccaf 100644 --- a/stdlib/hashtbl.mli +++ b/stdlib/hashtbl.mli @@ -56,11 +56,11 @@ val create : ?random: (* thwart tools/sync_stdlib_docs *) bool -> the table. The table grows as needed, so [n] is just an initial guess. - The optional [~][random] parameter (a boolean) controls whether + The optional [~random] parameter (a boolean) controls whether the internal organization of the hash table is randomized at each execution of [Hashtbl.create] or deterministic over all executions. - A hash table that is created with [~][random] set to [false] uses a + A hash table that is created with [~random] set to [false] uses a fixed hash function ({!hash}) to distribute keys among buckets. As a consequence, collisions between keys happen deterministically. In Web-facing applications or other @@ -69,7 +69,7 @@ val create : ?random: (* thwart tools/sync_stdlib_docs *) bool -> denial-of-service attack: the attacker sends input crafted to create many collisions in the table, slowing the application down. - A hash table that is created with [~][random] set to [true] uses the seeded + A hash table that is created with [~random] set to [true] uses the seeded hash function {!seeded_hash} with a seed that is randomly chosen at hash table creation time. In effect, the hash function used is randomly selected among [2^{30}] different hash functions. All these hash @@ -79,12 +79,12 @@ val create : ?random: (* thwart tools/sync_stdlib_docs *) bool -> or {!iter} is no longer deterministic: elements are enumerated in different orders at different runs of the program. - If no [~][random] parameter is given, hash tables are created + If no [~random] parameter is given, hash tables are created in non-random mode by default. This default can be changed either programmatically by calling {!randomize} or by setting the [R] flag in the [OCAMLRUNPARAM] environment variable. - @before 4.00.0 the [~][random] parameter was not present and all + @before 4.00.0 the [~random] parameter was not present and all hash tables were created in non-randomized mode. *) val clear : ('a, 'b) t -> unit @@ -486,7 +486,7 @@ module MakeSeeded (H : SeededHashedType) : SeededS with type key = H.t interface, but use the seeded hashing and equality functions specified in the functor argument [H] instead of generic equality and hashing. The [create] operation of the - result structure supports the [~][random] optional parameter + result structure supports the [~random] optional parameter and returns randomized hash tables if [~random:true] is passed or if randomization is globally on (see {!Hashtbl.randomize}). @since 4.00.0 *) diff --git a/stdlib/moreLabels.mli b/stdlib/moreLabels.mli index e40cc5f28d..e2d7fd04a0 100644 --- a/stdlib/moreLabels.mli +++ b/stdlib/moreLabels.mli @@ -73,11 +73,11 @@ module Hashtbl : sig the table. The table grows as needed, so [n] is just an initial guess. - The optional [~][random] parameter (a boolean) controls whether + The optional [~random] parameter (a boolean) controls whether the internal organization of the hash table is randomized at each execution of [Hashtbl.create] or deterministic over all executions. - A hash table that is created with [~][random] set to [false] uses a + A hash table that is created with [~random] set to [false] uses a fixed hash function ({!hash}) to distribute keys among buckets. As a consequence, collisions between keys happen deterministically. In Web-facing applications or other @@ -86,7 +86,7 @@ module Hashtbl : sig denial-of-service attack: the attacker sends input crafted to create many collisions in the table, slowing the application down. - A hash table that is created with [~][random] set to [true] uses the seeded + A hash table that is created with [~random] set to [true] uses the seeded hash function {!seeded_hash} with a seed that is randomly chosen at hash table creation time. In effect, the hash function used is randomly selected among [2^{30}] different hash functions. All these hash @@ -96,12 +96,12 @@ module Hashtbl : sig or {!iter} is no longer deterministic: elements are enumerated in different orders at different runs of the program. - If no [~][random] parameter is given, hash tables are created + If no [~random] parameter is given, hash tables are created in non-random mode by default. This default can be changed either programmatically by calling {!randomize} or by setting the [R] flag in the [OCAMLRUNPARAM] environment variable. - @before 4.00.0 the [~][random] parameter was not present and all + @before 4.00.0 the [~random] parameter was not present and all hash tables were created in non-randomized mode. *) val clear : ('a, 'b) t -> unit @@ -507,7 +507,7 @@ module Hashtbl : sig interface, but use the seeded hashing and equality functions specified in the functor argument [H] instead of generic equality and hashing. The [create] operation of the - result structure supports the [~][random] optional parameter + result structure supports the [~random] optional parameter and returns randomized hash tables if [~random:true] is passed or if randomization is globally on (see {!Hashtbl.randomize}). @since 4.00.0 *) diff --git a/stdlib/templates/hashtbl.template.mli b/stdlib/templates/hashtbl.template.mli index 772c969b68..dde04ec90f 100644 --- a/stdlib/templates/hashtbl.template.mli +++ b/stdlib/templates/hashtbl.template.mli @@ -56,11 +56,11 @@ val create : ?random: (* thwart tools/sync_stdlib_docs *) bool -> the table. The table grows as needed, so [n] is just an initial guess. - The optional [~][random] parameter (a boolean) controls whether + The optional [~random] parameter (a boolean) controls whether the internal organization of the hash table is randomized at each execution of [Hashtbl.create] or deterministic over all executions. - A hash table that is created with [~][random] set to [false] uses a + A hash table that is created with [~random] set to [false] uses a fixed hash function ({!hash}) to distribute keys among buckets. As a consequence, collisions between keys happen deterministically. In Web-facing applications or other @@ -69,7 +69,7 @@ val create : ?random: (* thwart tools/sync_stdlib_docs *) bool -> denial-of-service attack: the attacker sends input crafted to create many collisions in the table, slowing the application down. - A hash table that is created with [~][random] set to [true] uses the seeded + A hash table that is created with [~random] set to [true] uses the seeded hash function {!seeded_hash} with a seed that is randomly chosen at hash table creation time. In effect, the hash function used is randomly selected among [2^{30}] different hash functions. All these hash @@ -79,12 +79,12 @@ val create : ?random: (* thwart tools/sync_stdlib_docs *) bool -> or {!iter} is no longer deterministic: elements are enumerated in different orders at different runs of the program. - If no [~][random] parameter is given, hash tables are created + If no [~random] parameter is given, hash tables are created in non-random mode by default. This default can be changed either programmatically by calling {!randomize} or by setting the [R] flag in the [OCAMLRUNPARAM] environment variable. - @before 4.00.0 the [~][random] parameter was not present and all + @before 4.00.0 the [~random] parameter was not present and all hash tables were created in non-randomized mode. *) val clear : ('a, 'b) t -> unit @@ -486,7 +486,7 @@ module MakeSeeded (H : SeededHashedType) : SeededS with type key = H.t interface, but use the seeded hashing and equality functions specified in the functor argument [H] instead of generic equality and hashing. The [create] operation of the - result structure supports the [~][random] optional parameter + result structure supports the [~random] optional parameter and returns randomized hash tables if [~random:true] is passed or if randomization is globally on (see {!Hashtbl.randomize}). @since 4.00.0 *) |