From 8e7fdee6a5f42f23214d3724f59a30378fdaed79 Mon Sep 17 00:00:00 2001 From: Bruno Bernardo Date: Wed, 3 Apr 2024 11:35:39 +0200 Subject: [PATCH] Data-encoding: fix typo --- data-encoding/src/binary_description.mli | 2 +- data-encoding/src/binary_error.mli | 2 +- data-encoding/src/binary_error_types.mli | 2 +- data-encoding/src/binary_length.mli | 2 +- data-encoding/src/binary_reader.mli | 2 +- data-encoding/src/binary_schema.mli | 2 +- data-encoding/src/binary_size.mli | 2 +- data-encoding/src/binary_slicer.mli | 2 +- data-encoding/src/binary_stream.mli | 2 +- data-encoding/src/binary_stream_reader.mli | 2 +- data-encoding/src/binary_writer.mli | 2 +- data-encoding/src/bson.mli | 2 +- data-encoding/src/compact.mli | 2 +- data-encoding/src/encoding.mli | 2 +- data-encoding/src/json.mli | 2 +- data-encoding/src/json_stream.mli | 2 +- data-encoding/src/registration.mli | 2 +- data-encoding/src/tzEndian.mli | 2 +- data-encoding/src/uint_option.mli | 2 +- data-encoding/src/with_version.mli | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/data-encoding/src/binary_description.mli b/data-encoding/src/binary_description.mli index 95fe41a7a113..66bb27a4d75e 100644 --- a/data-encoding/src/binary_description.mli +++ b/data-encoding/src/binary_description.mli @@ -26,6 +26,6 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) val describe : 'a Encoding.t -> Binary_schema.t diff --git a/data-encoding/src/binary_error.mli b/data-encoding/src/binary_error.mli index 51aa5ea2a28e..7d3f9edfe9a9 100644 --- a/data-encoding/src/binary_error.mli +++ b/data-encoding/src/binary_error.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) open Binary_error_types diff --git a/data-encoding/src/binary_error_types.mli b/data-encoding/src/binary_error_types.mli index 07504f367d65..ae3c4086ee63 100644 --- a/data-encoding/src/binary_error_types.mli +++ b/data-encoding/src/binary_error_types.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) exception Invariant_guard of string diff --git a/data-encoding/src/binary_length.mli b/data-encoding/src/binary_length.mli index 3352580a8294..ceed4a890502 100644 --- a/data-encoding/src/binary_length.mli +++ b/data-encoding/src/binary_length.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) val length : 'a Encoding.t -> 'a -> int diff --git a/data-encoding/src/binary_reader.mli b/data-encoding/src/binary_reader.mli index c56361ceff6a..7288c7bfc952 100644 --- a/data-encoding/src/binary_reader.mli +++ b/data-encoding/src/binary_reader.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) val read : 'a Encoding.t -> diff --git a/data-encoding/src/binary_schema.mli b/data-encoding/src/binary_schema.mli index a4c8906af34a..0e389d8c10c3 100644 --- a/data-encoding/src/binary_schema.mli +++ b/data-encoding/src/binary_schema.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type integer_extended = [Binary_size.integer | `Int32 | `Int64] diff --git a/data-encoding/src/binary_size.mli b/data-encoding/src/binary_size.mli index a35ca86c72a0..5bcb0a774193 100644 --- a/data-encoding/src/binary_size.mli +++ b/data-encoding/src/binary_size.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) val bool : int diff --git a/data-encoding/src/binary_slicer.mli b/data-encoding/src/binary_slicer.mli index 9338b9ca493a..e34e6e6dc588 100644 --- a/data-encoding/src/binary_slicer.mli +++ b/data-encoding/src/binary_slicer.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type slice = {name : string; value : string; pretty_printed : string} diff --git a/data-encoding/src/binary_stream.mli b/data-encoding/src/binary_stream.mli index f3f1459d91ea..e1b062379ba9 100644 --- a/data-encoding/src/binary_stream.mli +++ b/data-encoding/src/binary_stream.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type t diff --git a/data-encoding/src/binary_stream_reader.mli b/data-encoding/src/binary_stream_reader.mli index edc91a3ecc02..8bb3c6641df3 100644 --- a/data-encoding/src/binary_stream_reader.mli +++ b/data-encoding/src/binary_stream_reader.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type 'ret status = | Success of {result : 'ret; size : int; stream : Binary_stream.t} diff --git a/data-encoding/src/binary_writer.mli b/data-encoding/src/binary_writer.mli index 2fdd4afe496a..7716ecfd1785 100644 --- a/data-encoding/src/binary_writer.mli +++ b/data-encoding/src/binary_writer.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type writer_state diff --git a/data-encoding/src/bson.mli b/data-encoding/src/bson.mli index e53c7085b4e1..fee07b5402fe 100644 --- a/data-encoding/src/bson.mli +++ b/data-encoding/src/bson.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type bson = Json_repr_bson.bson diff --git a/data-encoding/src/compact.mli b/data-encoding/src/compact.mli index bd61359ca545..b7a24e5edd16 100644 --- a/data-encoding/src/compact.mli +++ b/data-encoding/src/compact.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type 'a t diff --git a/data-encoding/src/encoding.mli b/data-encoding/src/encoding.mli index a5cd3a3905dd..e498b852f17a 100644 --- a/data-encoding/src/encoding.mli +++ b/data-encoding/src/encoding.mli @@ -27,7 +27,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. + for documentation. Note however that this module can be of interest to advanced users. You may read on if you need access to the concrete definition of the diff --git a/data-encoding/src/json.mli b/data-encoding/src/json.mli index 42acc4c6c4fb..35f7a173b09c 100644 --- a/data-encoding/src/json.mli +++ b/data-encoding/src/json.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type json = [ `O of (string * json) list diff --git a/data-encoding/src/json_stream.mli b/data-encoding/src/json_stream.mli index 65f80c1d6e6c..ace8ad79811d 100644 --- a/data-encoding/src/json_stream.mli +++ b/data-encoding/src/json_stream.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type jsonm_lexeme = [ `Null diff --git a/data-encoding/src/registration.mli b/data-encoding/src/registration.mli index c0c06f42b0de..6a2ac450fbd4 100644 --- a/data-encoding/src/registration.mli +++ b/data-encoding/src/registration.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type id = string diff --git a/data-encoding/src/tzEndian.mli b/data-encoding/src/tzEndian.mli index 558117fada03..fdfe1fe3f029 100644 --- a/data-encoding/src/tzEndian.mli +++ b/data-encoding/src/tzEndian.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type endianness = Big_endian | Little_endian [@@deriving hash] diff --git a/data-encoding/src/uint_option.mli b/data-encoding/src/uint_option.mli index 24deba1dea6c..441e61997fc7 100644 --- a/data-encoding/src/uint_option.mli +++ b/data-encoding/src/uint_option.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) (** diff --git a/data-encoding/src/with_version.mli b/data-encoding/src/with_version.mli index 2efb0aafb3c0..1b37f0ee4dbe 100644 --- a/data-encoding/src/with_version.mli +++ b/data-encoding/src/with_version.mli @@ -26,7 +26,7 @@ (** Like most other [.mli] files in this directory, this is not intended for end-users. Instead, the interface from this file is used internally to assemble the end-user-intended module {!Data_encoding}. Refer to that module - for doucmentation. *) + for documentation. *) type _ t -- GitLab