1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
$ ocamlc -c main.mli -bin-annot -I .
$ odoc compile -I . main.cmti
$ odoc compile -I . page.mld
$ odoc link -I . main.odoc
$ odoc link -I . page-page.odoc
$ odoc compile-index -o index.odoc-index --root ./
$ export SHERLODOC_DB=db.bin
$ export SHERLODOC_FORMAT=marshal
$ sherlodoc index index.odoc-index
$ sherlodoc search "unique_name"
val Main.unique_name : foo
$ sherlodoc search "multiple_hit"
val Main.multiple_hit_1 : foo
val Main.multiple_hit_2 : foo
val Main.multiple_hit_3 : foo
$ sherlodoc search --print-cost "name_conflict"
134 type Main.name_conflict = foo
234 val Main.name_conflict : foo
$ sherlodoc search "nesting_priority"
val Main.nesting_priority : foo
val Main.Nest.nesting_priority : foo
$ sherlodoc search "list"
type 'a Main.list
type 'a Main.List.t = 'a list
mod Main.List
val Main.Map.to_list : foo
val Main.List.map : ('a -> 'b) -> 'a t -> 'b t
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
val Main.foo : foo
$ sherlodoc search "map"
mod Main.Map
val Main.Map.to_list : foo
val Main.List.map : ('a -> 'b) -> 'a t -> 'b t
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
val Main.foo : foo
$ sherlodoc search "list map"
val Main.List.map : ('a -> 'b) -> 'a t -> 'b t
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.Map.to_list : foo
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
val Main.foo : foo
$ sherlodoc search "map2"
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
$ sherlodoc search ":moo"
val Main.value : moo
val Main.produce : unit -> moo
val Main.produce_2' : unit -> unit -> moo
$ sherlodoc search ":_ -> moo"
val Main.produce : unit -> moo
val Main.produce_2' : unit -> unit -> moo
val Main.value : moo
$ sherlodoc search ":moo -> _"
cons Main.MyExtension : moo -> extensible_type
val Main.consume : moo -> unit
val Main.consume_2 : moo -> moo -> unit
val Main.consume_2_other : moo -> t -> unit
$ sherlodoc search "modtype"
sig Main.Modtype
val Main.Modtype.v_modtype : foo
$ sherlodoc search "extensible"
type Main.extensible_type = ..
$ sherlodoc search "S"
mod Main.S_to_S1
sig Main.S
type Main.extensible_type = ..
type 'a Main.List.t = 'a list
mod Main.List
mod Main.Nest
type 'a Main.list
cons Main.MyExtension : moo -> extensible_type
val Main.consume : moo -> unit
val Main.Map.to_list : foo
val Main.nesting_priority : foo
val Main.consume_2 : moo -> moo -> unit
val Main.Nest.nesting_priority : foo
val Main.consume_2_other : moo -> t -> unit
val Main.List.map : ('a -> 'b) -> 'a t -> 'b t
val Main.foo : foo
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
$ sherlodoc search "qwertyuiopasdfghjklzxcvbnm"
[No results]
$ sherlodoc search "hidden"
[No results]
$ sherlodoc search ":mo"
val Main.value : moo
val Main.produce : unit -> moo
val Main.produce_2' : unit -> unit -> moo
$ sherlodoc search ":'a"
val Main.poly_param : 'a boo
val Main.poly_1 : 'a -> 'b -> 'c
val Main.List.map : ('a -> 'b) -> 'a t -> 'b t
val Main.poly_2 : 'a -> 'b -> 'c -> 'a -> 'b -> 'c
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
$ sherlodoc search ": 'a -> 'b -> 'c "
val Main.poly_1 : 'a -> 'b -> 'c
val Main.poly_2 : 'a -> 'b -> 'c -> 'a -> 'b -> 'c
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
$ sherlodoc search ": ('a -> 'b) -> 'a t -> 'b t"
val Main.List.map : ('a -> 'b) -> 'a t -> 'b t
val Main.List.map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val Main.List.rev_map2_exn : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
$ sherlodoc search ": 'a bo"
val Main.poly_param : 'a boo
$ sherlodoc search ":extensible_type"
cons Main.MyExtension : moo -> extensible_type
$ sherlodoc search ":exn"
exn Main.Explicit_exn : exn_payload -> exn
exn Main.Implicit_exn : exn_payload -> exn
cons Main.Very_explicit_exn : exn_payload -> exn
$ sherlodoc search ": exn_payload -> _"
exn Main.Explicit_exn : exn_payload -> exn
exn Main.Implicit_exn : exn_payload -> exn
cons Main.Very_explicit_exn : exn_payload -> exn
$ sherlodoc search ": long_name_type"
val Main.long_name_value : long_name_type
$ sherlodoc search ": long_nam"
val Main.long_name_value : long_name_type
$ sherlodoc search "long_name"
type Main.long_name_type
val Main.long_name_value : long_name_type
|
