Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation typos #161

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Documentation typos #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8449c96
Fix references `String to `Buffer
reynir Jan 12, 2024
e4f075c
Fix typo
reynir Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/de.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ val succ_distance : distances -> int -> unit
module Def : sig
type dst = [ `Channel of out_channel | `Buffer of Buffer.t | `Manual ]
(** The type for output destinations. With a [`Manual] destination the client
must provide output storage with {!dst}. With [`String] or [`Channel]
must provide output storage with {!dst}. With [`Buffer] or [`Channel]
destination the client can safely discard [`Flush] case (with [assert false]). *)

type dynamic
Expand Down
4 changes: 2 additions & 2 deletions lib/gz.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,11 @@ module Def : sig
type src = [ `Channel of in_channel | `String of string | `Manual ]
(** The type for input sources. With a [`Manual] source the client must
provide input with {!src}. With [`String] or [`Channel] source the client
can safely discard [`Await] cae (with [assert false]). *)
can safely discard [`Await] case (with [assert false]). *)

type dst = [ `Channel of out_channel | `Buffer of Buffer.t | `Manual ]
(** The type for output destinations. With a [`Manual] destination the client
must provide output storage with {!dst}. With [`String] or [`Channel]
must provide output storage with {!dst}. With [`Buffer] or [`Channel]
destination the client can safely discard [`Flush] case (with [assert
false]). *)

Expand Down
2 changes: 1 addition & 1 deletion lib/zl.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ module Def : sig

type dst = [ `Channel of out_channel | `Buffer of Buffer.t | `Manual ]
(** The type for output destinations. With a [`Manual] destination the client
must provide output storage with {!dst}. With [`String] or [`Channel]
must provide output storage with {!dst}. With [`Buffer] or [`Channel]
destination the client can safely discard [`Flush] case (with [assert false]). *)

type encoder
Expand Down