Skip to content

Commit

Permalink
Merge pull request #659 from talex5/fs-docs
Browse files Browse the repository at this point in the history
Mention Path module in File and Fs documentation
  • Loading branch information
talex5 authored Dec 18, 2023
2 parents a26c3eb + 0751f02 commit 21e05a8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
5 changes: 5 additions & 0 deletions lib_eio/file.mli
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
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

0 comments on commit 21e05a8

Please sign in to comment.