My own corner of monopam
fix: resolve odoc documentation warnings across monorepo
Fix invalid odoc markup in 54 files: convert {\!Module} to {!Module}
in fuzz .mli files, replace inline {v ... v} with [...] code spans,
fix "paragraph should begin on its own line" warnings, escape bare
brackets, and resolve ambiguous docstring placement (warning 50).
+70
-73
+1
-1
irmin/bin/cmd_serve.ml
+1
-1
irmin/bin/cmd_serve.ml
···
19
19
s;
20
20
Buffer.contents b
21
21
22
-
(** Convert IPLD value to JSON string, handling CID links as {"$link":"..."} *)
22
+
(** Convert IPLD value to JSON string, handling CID links as ["$link":"..."] *)
23
23
let rec ipld_to_json : Atp.Dagcbor.value -> string = function
24
24
| `Null -> "null"
25
25
| `Bool b -> if b then "true" else "false"
+4
-6
monopam/lib/opam_repo.ml
+4
-6
monopam/lib/opam_repo.ml
···
47
47
| _ -> None)
48
48
items
49
49
50
-
(** Extract package name from a dependency formula value.
51
-
Handles cases like:
50
+
(** Extract package name from a dependency formula value. Handles cases like:
52
51
- "pkgname"
53
-
- "pkgname" {>= "1.0"}
54
-
- "pkgname" {with-test}
55
-
Returns the package name if found. *)
52
+
- "pkgname" [>= "1.0"]
53
+
- "pkgname" [with-test] Returns the package name if found. *)
56
54
let rec extract_dep_name (v : OP.value) : string option =
57
55
match v.pelem with
58
56
| OP.String s -> Some s
···
212
210
in
213
211
String.concat "\n" lines
214
212
215
-
(** Replace url { src: "..." } section in content. *)
213
+
(** Replace url [src: "..."] section in content. *)
216
214
let replace_url_section content ~new_url =
217
215
let url_src =
218
216
let base =
+1
-1
monopam/lib/opam_transform.ml
+1
-1
monopam/lib/opam_transform.ml
···
22
22
in
23
23
String.concat "\n" lines
24
24
25
-
(** Remove existing url { ... } section if present *)
25
+
(** Remove existing url [...] section if present *)
26
26
let remove_url_section content =
27
27
let lines = String.split_on_char '\n' content in
28
28
let rec process lines in_url_block acc =
+1
-1
ocaml-aos/fuzz/fuzz_aos.mli
+1
-1
ocaml-aos/fuzz/fuzz_aos.mli
+2
-2
ocaml-atp/atp/lib/blob_ref.mli
+2
-2
ocaml-atp/atp/lib/blob_ref.mli
···
32
32
33
33
val to_dagcbor : t -> Dagcbor.value
34
34
(** [to_dagcbor t] encodes blob reference as IPLD Map:
35
-
{v {$type: "blob", ref: <cid>, mimeType: ..., size: ...} v}. *)
35
+
{v {$type: "blob", ref: <cid>, mimeType: ..., size: ...} v} *)
36
36
37
37
val of_dagcbor : Dagcbor.value -> t
38
38
(** [of_dagcbor v] decodes blob reference from IPLD.
···
61
61
Encodes as:
62
62
{v
63
63
{"$type": "blob", "ref": {"$link": "..."}, "mimeType": "...", "size": ...}
64
-
v}. *)
64
+
v} *)
+1
-1
ocaml-ax25/fuzz/fuzz_ax25.mli
+1
-1
ocaml-ax25/fuzz/fuzz_ax25.mli
+1
-1
ocaml-block/fuzz/fuzz_block.mli
+1
-1
ocaml-block/fuzz/fuzz_block.mli
+1
-1
ocaml-bloom/fuzz/fuzz_bloom.mli
+1
-1
ocaml-bloom/fuzz/fuzz_bloom.mli
+1
-1
ocaml-bpsec/fuzz/fuzz_bpsec.mli
+1
-1
ocaml-bpsec/fuzz/fuzz_bpsec.mli
+1
-1
ocaml-bundle/fuzz/fuzz_bundle.mli
+1
-1
ocaml-bundle/fuzz/fuzz_bundle.mli
+1
-1
ocaml-cbort/fuzz/fuzz_cbort.mli
+1
-1
ocaml-cbort/fuzz/fuzz_cbort.mli
+6
-7
ocaml-cdm/lib/cdm.mli
+6
-7
ocaml-cdm/lib/cdm.mli
···
237
237
val of_file : string -> (t list, error) result
238
238
(** [of_file path] parses a CSV file. *)
239
239
240
-
val fold_channel :
241
-
in_channel -> ('a -> t -> 'a) -> 'a -> ('a, error) result
242
-
(** [fold_channel ic f acc] folds over conjunction events without
243
-
building an intermediate list. Useful for large files. *)
240
+
val fold_channel : in_channel -> ('a -> t -> 'a) -> 'a -> ('a, error) result
241
+
(** [fold_channel ic f acc] folds over conjunction events without building an
242
+
intermediate list. Useful for large files. *)
244
243
end
245
244
246
245
(** JSON-ST parsing (Space-Track compatible format). *)
247
246
module Json_st : sig
248
247
val of_string : string -> (t list, error) result
249
248
(** [of_string s] parses a JSON-ST string. Expects a
250
-
{v {"tracssCdms": [...]} v} wrapper or a bare JSON array. *)
249
+
{v {"tracssCdms": [...]} v}
250
+
wrapper or a bare JSON array. *)
251
251
252
252
val of_single : string -> (t, error) result
253
253
(** [of_single s] parses a single CDM from a JSON-ST object. *)
···
267
267
val of_csv_file : string -> (t list, error) result
268
268
(** @deprecated Use {!Csv.of_file}. *)
269
269
270
-
val fold_csv_channel :
271
-
in_channel -> ('a -> t -> 'a) -> 'a -> ('a, error) result
270
+
val fold_csv_channel : in_channel -> ('a -> t -> 'a) -> 'a -> ('a, error) result
272
271
(** @deprecated Use {!Csv.fold_channel}. *)
273
272
274
273
(** {1 Accessors} *)
+1
-1
ocaml-cfdp/fuzz/fuzz_cfdp.mli
+1
-1
ocaml-cfdp/fuzz/fuzz_cfdp.mli
+1
-1
ocaml-cgr/fuzz/fuzz_cgr.mli
+1
-1
ocaml-cgr/fuzz/fuzz_cgr.mli
+1
-1
ocaml-cgr/gen/cgr_gen.mli
+1
-1
ocaml-cgr/gen/cgr_gen.mli
···
6
6
(** Synthetic contact plan generation for testing and simulation. *)
7
7
8
8
val nodes : int -> Cgr.Node.t list
9
-
(** [nodes n] creates [n] nodes named "N0", "N1", ..., "N{n-1}". *)
9
+
(** [nodes n] creates [n] nodes named "N0", "N1", ..., "N[n-1]". *)
10
10
11
11
val ring :
12
12
nodes:Cgr.Node.t list -> duration:float -> rate:float -> Cgr.Contact.t list
+1
-1
ocaml-clcw/fuzz/fuzz_clcw.mli
+1
-1
ocaml-clcw/fuzz/fuzz_clcw.mli
+1
-1
ocaml-cookeio/fuzz/fuzz_cookeio.mli
+1
-1
ocaml-cookeio/fuzz/fuzz_cookeio.mli
+1
-1
ocaml-coordinate/lib/coordinate.mli
+1
-1
ocaml-coordinate/lib/coordinate.mli
···
99
99
(** [vec3_length v] is the Euclidean length of [v]. *)
100
100
101
101
val normalize_angle : float -> float
102
-
(** [normalize_angle a] normalizes angle [a] to [0, 2pi). *)
102
+
(** [normalize_angle a] normalizes angle [a] to \[0, 2pi). *)
103
103
104
104
(** {1 Pretty-printing} *)
105
105
+1
-1
ocaml-cpio/fuzz/fuzz_cpio.mli
+1
-1
ocaml-cpio/fuzz/fuzz_cpio.mli
+1
-1
ocaml-crc/fuzz/fuzz_crc.mli
+1
-1
ocaml-crc/fuzz/fuzz_crc.mli
+1
-1
ocaml-crypto/fuzz/fuzz_crypto.mli
+1
-1
ocaml-crypto/fuzz/fuzz_crypto.mli
+1
-1
ocaml-csrf/fuzz/fuzz_csrf.mli
+1
-1
ocaml-csrf/fuzz/fuzz_csrf.mli
+1
-1
ocaml-git/fuzz/fuzz_config.mli
+1
-1
ocaml-git/fuzz/fuzz_config.mli
+1
-1
ocaml-git/fuzz/fuzz_index.mli
+1
-1
ocaml-git/fuzz/fuzz_index.mli
+1
-1
ocaml-github-oauth/fuzz/fuzz_github_oauth.mli
+1
-1
ocaml-github-oauth/fuzz/fuzz_github_oauth.mli
+1
-1
ocaml-openamp/fuzz/fuzz_openamp.mli
+1
-1
ocaml-openamp/fuzz/fuzz_openamp.mli
+3
-3
ocaml-openamp/test/test_remoteproc.ml
+3
-3
ocaml-openamp/test/test_remoteproc.ml
···
1
1
(** Tests for Openamp.Remoteproc module.
2
2
3
-
Uses Eio tmpdir to mock the Linux remoteproc sysfs interface.
4
-
Upstream test vectors from Linux kernel:
3
+
Uses Eio tmpdir to mock the Linux remoteproc sysfs interface. Upstream test
4
+
vectors from Linux kernel:
5
5
- State strings: "offline", "running", "crashed", "suspended"
6
-
- Sysfs layout: /sys/class/remoteproc/remoteprocN/{state,firmware,name} *)
6
+
- Sysfs layout: /sys/class/remoteproc/remoteprocN/[state,firmware,name] *)
7
7
8
8
(** Create a mock remoteproc sysfs entry under [dir]. *)
9
9
let remoteproc ~fs dir index ~state ~name =
+1
-1
ocaml-paseto/fuzz/fuzz_paseto.mli
+1
-1
ocaml-paseto/fuzz/fuzz_paseto.mli
+1
-1
ocaml-pbkdf2/fuzz/fuzz_pbkdf2.mli
+1
-1
ocaml-pbkdf2/fuzz/fuzz_pbkdf2.mli
+1
-1
ocaml-punycode/fuzz/fuzz_punycode.mli
+1
-1
ocaml-punycode/fuzz/fuzz_punycode.mli
+1
-1
ocaml-rate-limit/fuzz/fuzz_rate_limit.mli
+1
-1
ocaml-rate-limit/fuzz/fuzz_rate_limit.mli
+1
-1
ocaml-requests/fuzz/fuzz_requests.mli
+1
-1
ocaml-requests/fuzz/fuzz_requests.mli
+3
-3
ocaml-requests/lib/core/http_version.mli
+3
-3
ocaml-requests/lib/core/http_version.mli
···
55
55
Section 3.1}. *)
56
56
57
57
val alpn_h2 : string
58
-
(** ALPN protocol identifier for HTTP/2 over TLS, the string {v h2 v}.
59
-
Serialized as the two-octet sequence: 0x68, 0x32. *)
58
+
(** ALPN protocol identifier for HTTP/2 over TLS, the string [h2]. Serialized as
59
+
the two-octet sequence: 0x68, 0x32. *)
60
60
61
61
val alpn_http_1_1 : string
62
-
(** ALPN protocol identifier for HTTP/1.1, the string {v http/1.1 v}. *)
62
+
(** ALPN protocol identifier for HTTP/1.1, the string [http/1.1]. *)
63
63
64
64
val alpn_of_version : t -> string option
65
65
(** [alpn_of_version version] returns the ALPN identifier for a version. Returns
+1
-1
ocaml-requests/lib/features/proxy.mli
+1
-1
ocaml-requests/lib/features/proxy.mli
···
116
116
{[
117
117
HTTP_PROXY=http://user:pass@proxy.example.com:8080
118
118
NO_PROXY=localhost,*.internal.example.com,.example.org
119
-
]}. *)
119
+
]} *)
120
120
121
121
val from_env_for_url : string -> config option
122
122
(** [from_env_for_url url] reads proxy configuration appropriate for [url].
+2
-2
ocaml-requests/lib/features/websocket.mli
+2
-2
ocaml-requests/lib/features/websocket.mli
···
29
29
(** {1 Constants} *)
30
30
31
31
val protocol_version : string
32
-
(** The WebSocket protocol version string per RFC 6455 (always {v 13 v}).
33
-
Used as the value for the Sec-WebSocket-Version header. *)
32
+
(** The WebSocket protocol version string per RFC 6455 (always [13]). Used as
33
+
the value for the Sec-WebSocket-Version header. *)
34
34
35
35
val magic_guid : string
36
36
(** The magic GUID used in Sec-WebSocket-Accept computation.
+1
-1
ocaml-requests/lib/parsing/sf.mli
+1
-1
ocaml-requests/lib/parsing/sf.mli
···
32
32
33
33
val parameters_to_string : parameters -> string
34
34
(** [parameters_to_string params] serializes parameters to their Structured
35
-
Field representation (e.g., {v ;key=value;key2 v}). *)
35
+
Field representation (e.g., [;key=value;key2]). *)
36
36
37
37
(** {1 Inner Lists} *)
38
38
+4
-4
ocaml-requests/lib/requests.mli
+4
-4
ocaml-requests/lib/requests.mli
···
468
468
?max_redirects ?path_params ~method_ url] makes a concurrent HTTP request.
469
469
@param path_params
470
470
List of (key, value) pairs for URL template substitution (per
471
-
Recommendation #29). Example: {v ~path_params:[("id", "123")] v} with
472
-
URL {v /users/{id} v}. *)
471
+
Recommendation #29). Example: [~path_params:[("id", "123")]] with URL
472
+
[/users/\{id\}]. *)
473
473
474
474
val get :
475
475
t ->
···
484
484
concurrent GET request.
485
485
@param params Query parameters to append to URL.
486
486
@param path_params
487
-
Path template substitutions (e.g., {v /users/{id} v} with
488
-
{v ("id", "123") v}). *)
487
+
Path template substitutions (e.g., [/users/\{id\}] with [("id", "123")]).
488
+
*)
489
489
490
490
val post :
491
491
t ->
+1
-1
ocaml-rpmsg/fuzz/fuzz_rpmsg.mli
+1
-1
ocaml-rpmsg/fuzz/fuzz_rpmsg.mli
+1
-1
ocaml-sdnv/fuzz/fuzz_sdnv.mli
+1
-1
ocaml-sdnv/fuzz/fuzz_sdnv.mli
+1
-1
ocaml-sgp4/fuzz/fuzz_sgp4.mli
+1
-1
ocaml-sgp4/fuzz/fuzz_sgp4.mli
+1
-1
ocaml-sle/fuzz/fuzz_bind.mli
+1
-1
ocaml-sle/fuzz/fuzz_bind.mli
+1
-1
ocaml-sle/fuzz/fuzz_common.mli
+1
-1
ocaml-sle/fuzz/fuzz_common.mli
+1
-1
ocaml-sle/fuzz/fuzz_isp1.mli
+1
-1
ocaml-sle/fuzz/fuzz_isp1.mli
+1
-1
ocaml-sle/fuzz/fuzz_raf.mli
+1
-1
ocaml-sle/fuzz/fuzz_raf.mli
+1
-1
ocaml-sle/fuzz/fuzz_tml.mli
+1
-1
ocaml-sle/fuzz/fuzz_tml.mli
+1
-1
ocaml-space-packet/fuzz/fuzz_space_packet.mli
+1
-1
ocaml-space-packet/fuzz/fuzz_space_packet.mli
+1
-1
ocaml-spake2/fuzz/fuzz_spake2.mli
+1
-1
ocaml-spake2/fuzz/fuzz_spake2.mli
+1
-1
ocaml-sqlite/fuzz/fuzz_sqlite.mli
+1
-1
ocaml-sqlite/fuzz/fuzz_sqlite.mli
+1
-1
ocaml-squashfs/fuzz/fuzz_squashfs.mli
+1
-1
ocaml-squashfs/fuzz/fuzz_squashfs.mli
+1
-1
ocaml-srp/fuzz/fuzz_srp.mli
+1
-1
ocaml-srp/fuzz/fuzz_srp.mli
+1
-1
ocaml-streaming-aead/fuzz/fuzz_streaming_aead.mli
+1
-1
ocaml-streaming-aead/fuzz/fuzz_streaming_aead.mli
+1
-1
ocaml-tar/fuzz/fuzz_tar.mli
+1
-1
ocaml-tar/fuzz/fuzz_tar.mli