Skip to content

Commit ad90c35

Browse files
Better names for env_and_file
It didn't return a file. Most of the time it returned a filename, but even then it would be used in ways where what it returned was a piece of OCaml code (`--prelude-str`) so calling it `env_and_file` was pretty inaccurate.
1 parent ca53781 commit ad90c35

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

bin/cli.ml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,11 @@ let verbose_findlib =
6868

6969
let prelude =
7070
let parse s =
71-
let env, file = Mdx.Prelude.env_and_file s in
72-
let parse, _print = Arg.non_dir_file in
73-
match parse file with `Ok _ -> `Ok (env, file) | `Error e -> `Error e
71+
let env, filename = Mdx.Prelude.env_and_payload s in
72+
let parse, _pp = Arg.non_dir_file in
73+
match parse filename with
74+
| `Ok _ -> `Ok (env, filename)
75+
| `Error _ as e -> e
7476
in
7577
let prelude = (parse, Mdx.Prelude.pp) in
7678
let doc =
@@ -91,7 +93,7 @@ let prelude_str =
9193
not contain any spaces. Multiple prelude strings can be provided: they \
9294
will be evaluated in the order they are provided on the command-line."
9395
in
94-
let parse s = `Ok (Mdx.Prelude.env_and_file s) in
96+
let parse s = `Ok (Mdx.Prelude.env_and_payload s) in
9597
let prelude = (parse, Mdx.Prelude.pp) in
9698
named
9799
(fun x -> `Prelude_str x)

lib/prelude.ml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ let pp ppf = function
2121
| `One ocaml_env, filename ->
2222
Fmt.pf ppf "(`One %a, %S)" Ocaml_env.pp ocaml_env filename
2323

24-
let env_and_file f =
24+
let env_and_payload f =
2525
match Astring.String.cut ~sep:":" f with
2626
| None -> (`All, f)
2727
| Some (e, f) ->

lib/prelude.mli

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ type t = [ `All | `One of Ocaml_env.t ] * string
1818

1919
val pp : t Fmt.t
2020

21-
val env_and_file : string -> t
22-
(** [env_and_file s] returns the environment and file/prelude string described
21+
val env_and_payload : string -> t
22+
(** [env_and_payload s] returns the environment and file/prelude string described
2323
by [s].
24-
I.e. [env_and_file "a:f"] associates [f] to the environment named [a],
25-
[env_and_file " :f"] associates [f] to the default environment, and
26-
[env_and_file "f"] associates [f] to all environments. *)
24+
I.e. [env_and_payload "a:f"] associates [f] to the environment named [a],
25+
[env_and_payload " :f"] associates [f] to the default environment, and
26+
[env_and_payload "f"] associates [f] to all environments. *)

0 commit comments

Comments
 (0)