Skip to content

Commit 6b93b9a

Browse files
committed
update code doc
1 parent 4e57aff commit 6b93b9a

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

src/client/opamArg.mli

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ val build_option_section: string
114114
(** Build options *)
115115
val build_options: build_options Term.t
116116

117-
(** Instal and reinstall options *)
117+
(** Install and reinstall options *)
118118
val assume_built: bool Term.t
119119

120120
(** Applly build options *)

src/format/opamFile.ml

+5-4
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,9 @@ end
186186

187187
(** I - Raw text files (no parsing) *)
188188

189-
(** Compiler and package description files
190-
(<repo>/packages/.../descr, <repo>/compilers/.../<v>.descr):
191-
one-line title and content *)
189+
(** Compiler and package description opam file fields: one-line title and
190+
content. Formerly, (<repo>/packages/.../descr,
191+
<repo>/compilers/.../<v>.descr) *)
192192

193193
module DescrIO = struct
194194

@@ -1849,7 +1849,8 @@ module Repo = struct
18491849
end
18501850

18511851

1852-
(** Package url files (<repo>/packages/.../url) *)
1852+
(** Package url field in opam file. Formerly, file
1853+
(<repo>/packages/.../url) *)
18531854

18541855
module URLSyntax = struct
18551856

src/state/opamSwitchState.mli

+4-4
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,16 @@ val opam: 'a switch_state -> package -> OpamFile.OPAM.t
7777
any *)
7878
val opam_opt: 'a switch_state -> package -> OpamFile.OPAM.t option
7979

80-
(** Return the URL file for the given package *)
80+
(** Return the URL field for the given package *)
8181
val url: 'a switch_state -> package -> OpamFile.URL.t option
8282

83-
(** Returns the primary URL from the URL file of the given package *)
83+
(** Returns the primary URL from the URL field of the given package *)
8484
val primary_url: 'a switch_state -> package -> url option
8585

86-
(** Return the Descr file for the given package (or an empty descr if none) *)
86+
(** Return the descr field for the given package (or an empty descr if none) *)
8787
val descr: 'a switch_state -> package -> OpamFile.Descr.t
8888

89-
(** Return the Descr file for the given package *)
89+
(** Return the descr field for the given package *)
9090
val descr_opt: 'a switch_state -> package -> OpamFile.Descr.t option
9191

9292
(** Returns the full paths of overlay files under the files/ directory *)

0 commit comments

Comments
 (0)