this repo has no description
Fix odoc documentation warnings across day10, js_top_worker, and extensions
Escape curly braces and fix odoc reference syntax to eliminate warnings
with (warnings fatal):
- Replace {dir}, {pkg}, {hash} etc with [dir], [<pkg>], [<hash>] or
{[ code blocks ]} as appropriate
- Fix {!Stdlib.Out_channel.with_open_gen} -> [Out_channel.with_open_gen]
in sherlodoc type_polarity.mli
- Fix @scrolly.<theme> -> [@scrolly.<theme>] in scrollycode extension
- Fix JSON format in findlibish.ml doc comment
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
+2
-2
+2
-2
sherlodoc/db/type_polarity.mli
+2
-2
sherlodoc/db/type_polarity.mli
···
23
23
24
24
How is polarity computed exactly ? When you have [t -> u], the polarity of [t]
25
25
is inversed, and the polarity of [u] stays the same. A good example of this is
26
-
the type of {!Stdlib.Out_channel.with_open_gen} :
26
+
the type of [Out_channel.with_open_gen] :
27
27
28
28
{[
29
29
val with_open_gen : open_flag list -> int -> string -> (t -> 'a) -> 'a
···
32
32
Here the polarities are [-open_flag list], [-int], [-string], [+Out_channel.t],
33
33
[-'a] and [+'a]. The fact that we have [+Out_channel.t] might be puzzling at
34
34
first, because an [Out_channel.t] is not returned by the function, but
35
-
{!Stdlib.Out_channel.with_open_gen} is indeed one of the possible ways to create
35
+
[Out_channel.with_open_gen] is indeed one of the possible ways to create
36
36
an [Out_channel.t].
37
37
38
38
There is however a complication. If the user queries for [int -> int -> string],