The unpac monorepo manager self-hosting as a monorepo using unpac
Minor documentation fixes
authored by
Matthias Horn
and committed by
GitHub
fe76da8f
d86865c3
+5
-5
+5
-5
vendor/opam/base64/src/base64_rfc2045.mli
+5
-5
vendor/opam/base64/src/base64_rfc2045.mli
···
72
72
73
73
type encode = [`Await | `End | `Char of char]
74
74
75
-
(** The type for Quoted-Printable encoder. *)
75
+
(** The type for Base64 (RFC2045) encoder. *)
76
76
type encoder
77
77
78
78
val encoder : dst -> encoder
79
-
(** [encoder dst] is an encoder for quoted-printable that outputs to [dst]. *)
79
+
(** [encoder dst] is an encoder for Base64 (RFC2045) that outputs to [dst]. *)
80
80
81
81
val encode : encoder -> encode -> [`Ok | `Partial]
82
82
(** [encode e v]: is {ul {- [`Partial] iff [e] has a [`Manual] destination and
83
83
needs more output storage. The client must use {!dst} to provide a new
84
84
buffer and then call {!encode} with [`Await] until [`Ok] is returned.} {-
85
-
[`Ok] when the encoder is ready to encode a new [`Char], [`Line_break] or
85
+
[`Ok] when the encoder is ready to encode a new [`Char] or
86
86
[`End]}}
87
87
88
88
For [`Manual] destination, encoding [`End] always return [`Partial], the
89
89
client should continue as usual with [`Await] until [`Ok] is returned at
90
-
which point {!dst_rem} [encoder] is guaranteed to be the sode of the last
90
+
which point {!dst_rem} [encoder] is guaranteed to be the size of the last
91
91
provided buffer (i.e. nothing was written).
92
92
93
-
{b Raises.} [Invalid_argument] if a [`Char], [`Line_break] or [`End] is
93
+
{b Raises.} [Invalid_argument] if a [`Char] or [`End] is
94
94
encoded after a [`Partial] encode. *)
95
95
96
96
val encoder_dst : encoder -> dst