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.

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

OpamAction.install_package documentation inaccuracy #5207

Closed
reynir opened this issue Jul 28, 2022 · 0 comments · Fixed by #5215
Closed

OpamAction.install_package documentation inaccuracy #5207

reynir opened this issue Jul 28, 2022 · 0 comments · Fixed by #5215

Comments

@reynir
Copy link
Contributor

reynir commented Jul 28, 2022

The documentation speaks of returning None or Some exn while the type says it returns an Either.t (roughly).

(** [install_package t pkg] installs an already built package. Returns
[None] on success, [Some exn] on error. Do not update opam's
metadata. See {!build_package} to build the package. *)
val install_package:
rw switch_state -> ?test:bool -> ?doc:bool -> ?tools:bool -> ?build_dir:dirname -> package ->
(OpamFile.Dot_config.t option, exn) OpamCompat.Either.t OpamProcess.job

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants