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

Jump to bottom

Mention Path module in File and Fs documentation #659

Merged
merged 1 commit into from
Dec 18, 2023
Merged

Mention Path module in File and Fs documentation #659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions lib_eio/file.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
(** Files implement the {!Flow} APIs, which can be used for reading and writing data.
This module provides additonal file-specific operations, such as seeking within a file.

To get an open file, use the functions in the {!Path} module. *)

open Std

(** {2 Types} *)
Expand Down
7 changes: 6 additions & 1 deletion lib_eio/fs.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
(** Defines types used by file-systems. *)
(** Note: file-system operations, such as opening or deleting files,
can be found in the {!Path} module. *)

open Std

(** {2 Types} *)

type path = string

type error =
Expand Down Expand Up @@ -44,6 +47,8 @@ type dir_ty = [`Dir]
type 'a dir = ([> dir_ty] as 'a) r
(** Note: use the functions in {!Path} to access directories. *)

(** {2 Provider Interface} *)

module Pi = struct
module type DIR = sig
type t
Expand Down
Loading