Skip to content

Commit

Permalink
chore: fix the [Path.follow_symlink] docstring (#10287)
Browse files Browse the repository at this point in the history
Signed-off-by: Antonio Nuno Monteiro <anmonteiro@gmail.com>
  • Loading branch information
anmonteiro committed Mar 20, 2024
1 parent 171c231 commit f70b327
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion otherlibs/stdune/src/path.mli
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,13 @@ val rename : t -> t -> unit
you need to modify existing permissions in a non-trivial way. *)
val chmod : t -> mode:int -> unit

(** Attempts to resolve a symlink. Returns [None] if the path isn't a symlink *)
(** Attempts to resolve a symlink. Returns:
- [Ok path] with the resolved destination
- [Error Not_a_symlink] if the path isn't a symlink
- [Error Max_depth_exceeded] if the function reached the maximum symbolic
link depth
- [Error (Unix_error _)] with the underlying syscall error. *)
val follow_symlink : t -> (t, Fpath.follow_symlink_error) result

(** [drop_prefix_exn t ~prefix] drops the [prefix] from a path, including any
Expand Down

0 comments on commit f70b327

Please sign in to comment.