diff --git a/src/binary_description.mli b/src/binary_description.mli index 95fe41a7a113b23c5503d2d0817e40ed139e01b3..66bb27a4d75e7425e30b68b683a31fcba6bec3e6 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 51aa5ea2a28e0cfd1a4321b4622753499516ade5..7d3f9edfe9a9df572d8dbf03c09040e4e3b8487b 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 07504f367d659e091ad30af4c18c1640d98007ac..ae3c4086ee63fe3e492f7580e5a7a9d9a5e93a65 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 3352580a8294c89c830618dca35adf6d5e0114fe..ceed4a890502b73bfa2e89825cd8784a2a43048a 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 c56361ceff6a1524d6668073fe51e7e11addead0..7288c7bfc9525970e9dcd2fbbaa3f1ab1323726b 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 a4c8906af34a3f7b3de0e3e10c7398899b861895..0e389d8c10c3e5df8b3508e327e059acdd18331c 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 a35ca86c72a0753ad75a7e0d6a17dbbe01e06564..5bcb0a7741935a44f8f539a0421b52f574f1d030 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 9338b9ca493ae6e4580ece4aa22edfeb1ad6187e..e34e6e6dc588dd633d81d8abeb52b21daab0c140 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 f3f1459d91ea6610a7ad09cb5bb98ad65965d3dd..e1b062379ba953062293aee6b07316fa97384b27 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 edc91a3ecc0287c6c98fd6536445cb7fbf652ead..8bb3c6641df3b7f70ebd1c70227417ddfdeb7841 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 2fdd4afe496acbdfb2b4bc05b550d3996c926246..7716ecfd178587d34879cf6693a441c146b4db72 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 e53c7085b4e1eca415ddcf7d7179417016502af6..fee07b5402fe9c0f138445cc88e3a92ed6429d38 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 bd61359ca54545f16c4c6f6f8ec78cda280bc8b1..b7a24e5edd16f5a17a10c7dc79d294b94f070fbe 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 a5cd3a3905dd4615db52174523cca797d73572d2..e498b852f17ab7dde571b04345dd1b3653c66e85 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 42acc4c6c4fb4fc1ebd86948daf16243d33ea849..35f7a173b09cb5a3e64fd836cd122ab8bf589a49 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 65f80c1d6e6c471d5685064dc0adcb9c5da73d32..ace8ad79811ded76f537e27cad51202ef5b08158 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 c0c06f42b0de615a83bd8a9d576e5584ba40b7ca..6a2ac450fbd455df232bddbd9574c7d1d8daa32d 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/tutorial.md b/src/tutorial.md index 82913f9c4087c876233f94c76ca90550a14a9d97..3a732e398c337559b21dd83d41da3fdbe077024e 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 ebe3a4be563c9fb6e84be5ad58721b68aa188f45..fdab3cc22d1098ddcd6d27ff1cdeeb6a89dc4ce4 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. diff --git a/src/tzEndian.mli b/src/tzEndian.mli index 558117fada03496a1b6a514cd58dad943a60a956..fdfe1fe3f02906a0c06b7e542d5fe56fe976012d 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 24deba1dea6c26a238098d75911703f357d9d3e4..441e61997fc78c16be7af50ca5bee7447861624e 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 2efb0aafb3c084dda25fc88e2e8b442c35583974..1b37f0ee4dbecde0a489325088bb5c65276eb880 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