From 4978f60b80d6898170898bc8f22496c2b14c42b0 Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Tue, 28 Feb 2023 10:30:51 +0100 Subject: [PATCH 1/2] Typos in tutorial --- src/tutorial.md | 6 +++--- src/tutorial.mld | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/tutorial.md b/src/tutorial.md index 82913f9c..3a732e39 100644 --- a/src/tutorial.md +++ b/src/tutorial.md @@ -54,7 +54,7 @@ module Binary : sig type read_error = … type write_error = … val of_string : 'a encoding -> string -> ('a, read_error) result - val to_string : 'a encoding -> 'a -> (string, read_error) result + val to_string : 'a encoding -> 'a -> (string, write_error) result (* and some more functions, detailed below *) end ``` @@ -634,7 +634,7 @@ functions. Requesting a new element of the blit-instruction sequence forces elements of the underlying lexeme sequence. -The documentation of these function give more details about valid use cases, +The documentation of these functions gives more details about valid use cases, caveats and such. Read before use. @@ -743,7 +743,7 @@ encoding, it raises an exception. This happens when: ## Part 3: An encyclopedic list of all combinators -This section aims to covers each combinator in as much detail as you might ever +This section aims to cover each combinator in as much detail as you might ever want. If you find that you need more details, please open an issue on the project's repository or get in touch with one of the maintainers. diff --git a/src/tutorial.mld b/src/tutorial.mld index ebe3a4be..fdab3cc2 100644 --- a/src/tutorial.mld +++ b/src/tutorial.mld @@ -54,7 +54,7 @@ module Binary : sig type read_error = … type write_error = … val of_string : 'a encoding -> string -> ('a, read_error) result - val to_string : 'a encoding -> 'a -> (string, read_error) result + val to_string : 'a encoding -> 'a -> (string, write_error) result (* and some more functions, detailed below *) end ]} @@ -639,7 +639,7 @@ functions. Requesting a new element of the blit-instruction sequence forces elements of the underlying lexeme sequence. -The documentation of these function give more details about valid use cases, +The documentation of these functions gives more details about valid use cases, caveats and such. Read before use. {2 Limitations} @@ -744,7 +744,7 @@ array). {1 Part 3: An encyclopedic list of all combinators} -This section aims to covers each combinator in as much detail as you might ever +This section aims to cover each combinator in as much detail as you might ever want. If you find that you need more details, please open an issue on the project's repository or get in touch with one of the maintainers. -- GitLab From 8a2f3da97fc2f83cc983ab7cb1b74d5bb236a534 Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Tue, 28 Feb 2023 10:31:36 +0100 Subject: [PATCH 2/2] Typo in mli --- src/binary_description.mli | 2 +- src/binary_error.mli | 2 +- src/binary_error_types.mli | 2 +- src/binary_length.mli | 2 +- src/binary_reader.mli | 2 +- src/binary_schema.mli | 2 +- src/binary_size.mli | 2 +- src/binary_slicer.mli | 2 +- src/binary_stream.mli | 2 +- src/binary_stream_reader.mli | 2 +- src/binary_writer.mli | 2 +- src/bson.mli | 2 +- src/compact.mli | 2 +- src/encoding.mli | 2 +- src/json.mli | 2 +- src/json_stream.mli | 2 +- src/registration.mli | 2 +- src/tzEndian.mli | 2 +- src/uint_option.mli | 2 +- src/with_version.mli | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/binary_description.mli b/src/binary_description.mli index 95fe41a7..66bb27a4 100644 --- a/src/binary_description.mli +++ b/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/src/binary_error.mli b/src/binary_error.mli index 51aa5ea2..7d3f9edf 100644 --- a/src/binary_error.mli +++ b/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/src/binary_error_types.mli b/src/binary_error_types.mli index 07504f36..ae3c4086 100644 --- a/src/binary_error_types.mli +++ b/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/src/binary_length.mli b/src/binary_length.mli index 3352580a..ceed4a89 100644 --- a/src/binary_length.mli +++ b/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/src/binary_reader.mli b/src/binary_reader.mli index c56361ce..7288c7bf 100644 --- a/src/binary_reader.mli +++ b/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/src/binary_schema.mli b/src/binary_schema.mli index a4c8906a..0e389d8c 100644 --- a/src/binary_schema.mli +++ b/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/src/binary_size.mli b/src/binary_size.mli index a35ca86c..5bcb0a77 100644 --- a/src/binary_size.mli +++ b/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/src/binary_slicer.mli b/src/binary_slicer.mli index 9338b9ca..e34e6e6d 100644 --- a/src/binary_slicer.mli +++ b/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/src/binary_stream.mli b/src/binary_stream.mli index f3f1459d..e1b06237 100644 --- a/src/binary_stream.mli +++ b/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/src/binary_stream_reader.mli b/src/binary_stream_reader.mli index edc91a3e..8bb3c664 100644 --- a/src/binary_stream_reader.mli +++ b/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/src/binary_writer.mli b/src/binary_writer.mli index 2fdd4afe..7716ecfd 100644 --- a/src/binary_writer.mli +++ b/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/src/bson.mli b/src/bson.mli index e53c7085..fee07b54 100644 --- a/src/bson.mli +++ b/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/src/compact.mli b/src/compact.mli index bd61359c..b7a24e5e 100644 --- a/src/compact.mli +++ b/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/src/encoding.mli b/src/encoding.mli index a5cd3a39..e498b852 100644 --- a/src/encoding.mli +++ b/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/src/json.mli b/src/json.mli index 42acc4c6..35f7a173 100644 --- a/src/json.mli +++ b/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/src/json_stream.mli b/src/json_stream.mli index 65f80c1d..ace8ad79 100644 --- a/src/json_stream.mli +++ b/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/src/registration.mli b/src/registration.mli index c0c06f42..6a2ac450 100644 --- a/src/registration.mli +++ b/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/src/tzEndian.mli b/src/tzEndian.mli index 558117fa..fdfe1fe3 100644 --- a/src/tzEndian.mli +++ b/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/src/uint_option.mli b/src/uint_option.mli index 24deba1d..441e6199 100644 --- a/src/uint_option.mli +++ b/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/src/with_version.mli b/src/with_version.mli index 2efb0aaf..1b37f0ee 100644 --- a/src/with_version.mli +++ b/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