Skip to content

Fix docs's expected results and document limitations #65

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.

Sign up for GitHub

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

Merged
fantazio merged 8 commits into from
Mar 23, 2026
Merged

Fix docs's expected results and document limitations #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d3f751d
[check][exp] fix expected results for docs
fantazio Mar 13, 2026
1025e88
[src][deadCode] export at most 1 value per loc
fantazio Mar 13, 2026
53b0668
[src][deadCode] only export values owned by the current module
fantazio Mar 13, 2026
288abb6
[src][deadCode] only assoc if one location belongs to the current com…
fantazio Mar 13, 2026
197b22c
[docs][exported_values] update include doc
fantazio Mar 16, 2026
c6cafff
[docs][exported_values] document limitations
fantazio Mar 16, 2026
9c9c5ac
[docs][exported_values] add issue #55 to limitations
fantazio Mar 16, 2026
f4a0a85
[docs][exported_values] fix missing section description
fantazio Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions check/classic/classic.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down
16 changes: 11 additions & 5 deletions check/classic/classic.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:26: Internal_app.unused

./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Original.unused
./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Reexport.unused: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:15: Redefine.unused

./examples/docs/exported_values/code_constructs/modsig/modsig_lib.ml:6: Original.unused
Expand All @@ -26,6 +25,11 @@
./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:3: goodbye
./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world

./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
./examples/using_dune/preprocessed_lib/preprocessed.mli:3: internally_used
./examples/using_dune/preprocessed_lib/preprocessed.mli:38: internally_used_f
Expand Down Expand Up @@ -570,6 +574,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down Expand Up @@ -617,7 +623,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 531
Success: 530
Failed: 1
Ratio: 99.8116760829%
Total: 536
Success: 531
Failed: 5
Ratio: 99.0671641791%
2 changes: 2 additions & 0 deletions check/internal/internal.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down
16 changes: 11 additions & 5 deletions check/internal/internal.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:26: Internal_app.unused

./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Original.unused
./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Reexport.unused: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:15: Redefine.unused

./examples/docs/exported_values/code_constructs/modsig/modsig_lib.ml:6: Original.unused
Expand All @@ -16,6 +15,11 @@

./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused

./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused

Expand Down Expand Up @@ -525,6 +529,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down Expand Up @@ -572,7 +578,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 489
Success: 488
Failed: 1
Ratio: 99.7955010225%
Total: 494
Success: 489
Failed: 5
Ratio: 98.987854251%
4 changes: 4 additions & 0 deletions check/threshold-1/threshold-1.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:9: F.internally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:14: Internal_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:15: Internal_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:19: External_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:20: External_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:24: Internal_app.externally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:25: Internal_app.internally_used

Expand Down Expand Up @@ -899,6 +901,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down
21 changes: 13 additions & 8 deletions check/threshold-1/threshold-1.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:26: Internal_app.unused

./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Original.unused
./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Reexport.unused: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:15: Redefine.unused

./examples/docs/exported_values/code_constructs/modsig/modsig_lib.ml:6: Original.unused
Expand All @@ -16,6 +15,11 @@

./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused

./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused

Expand Down Expand Up @@ -108,14 +112,13 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:9: F.internally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:14: Internal_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:15: Internal_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:19: External_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:20: External_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:24: Internal_app.externally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:25: Internal_app.internally_used

./examples/docs/exported_values/code_constructs/include/include_lib.ml:3: Original.used_directly
./examples/docs/exported_values/code_constructs/include/include_lib.ml:3: Reexport.used_directly: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:4: Original.used_indirectly
./examples/docs/exported_values/code_constructs/include/include_lib.ml:4: Redefine.used_indirectly: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:4: Reexport.used_indirectly: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:14: Redefine.used_directly

./examples/docs/exported_values/code_constructs/modsig/modsig_lib.ml:3: Original.used_directly
Expand Down Expand Up @@ -903,6 +906,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down Expand Up @@ -950,7 +955,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 821
Success: 817
Failed: 4
Ratio: 99.5127892814%
Total: 825
Success: 820
Failed: 5
Ratio: 99.3939393939%
11 changes: 4 additions & 7 deletions check/threshold-3-0.5/threshold-3-0.5.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:9: F.internally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:14: Internal_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:15: Internal_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:19: External_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:20: External_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:24: Internal_app.externally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:25: Internal_app.internally_used

Expand Down Expand Up @@ -334,13 +336,6 @@

.>-> ALMOST UNUSED EXPORTED VALUES: Called 2 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:19: External_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:20: External_param.unused_required

./examples/docs/exported_values/code_constructs/modtyp/modtyp_lib.mli:13: M_subst.externally_used
./examples/docs/exported_values/code_constructs/modtyp/modtyp_lib.mli:13: M_subst.internally_used
./examples/docs/exported_values/code_constructs/modtyp/modtyp_lib.mli:13: M_subst.unused

./examples/docs/exported_values/hello_world/hello_world_lib.mli:4: world
./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:4: world
Expand Down Expand Up @@ -1295,6 +1290,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down
28 changes: 13 additions & 15 deletions check/threshold-3-0.5/threshold-3-0.5.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:26: Internal_app.unused

./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Original.unused
./examples/docs/exported_values/code_constructs/include/include_lib.ml:5: Reexport.unused: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:15: Redefine.unused

./examples/docs/exported_values/code_constructs/modsig/modsig_lib.ml:6: Original.unused
Expand All @@ -16,6 +15,11 @@

./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused

./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused

Expand Down Expand Up @@ -108,14 +112,13 @@
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:9: F.internally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:14: Internal_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:15: Internal_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:19: External_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:20: External_param.unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:24: Internal_app.externally_used
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:25: Internal_app.internally_used

./examples/docs/exported_values/code_constructs/include/include_lib.ml:3: Original.used_directly
./examples/docs/exported_values/code_constructs/include/include_lib.ml:3: Reexport.used_directly: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:4: Original.used_indirectly
./examples/docs/exported_values/code_constructs/include/include_lib.ml:4: Redefine.used_indirectly: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:4: Reexport.used_indirectly: Should not be detected
./examples/docs/exported_values/code_constructs/include/include_lib.ml:14: Redefine.used_directly

./examples/docs/exported_values/code_constructs/modsig/modsig_lib.ml:3: Original.used_directly
Expand Down Expand Up @@ -338,13 +341,6 @@

.>-> ALMOST UNUSED EXPORTED VALUES: Called 2 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:19: External_param.used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:20: External_param.unused_required

./examples/docs/exported_values/code_constructs/modtyp/modtyp_lib.mli:13: M_subst.externally_used
./examples/docs/exported_values/code_constructs/modtyp/modtyp_lib.mli:13: M_subst.internally_used
./examples/docs/exported_values/code_constructs/modtyp/modtyp_lib.mli:13: M_subst.unused

./examples/docs/exported_values/hello_world/hello_world_lib.mli:4: world
./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:4: world
Expand Down Expand Up @@ -1299,6 +1295,8 @@ Nothing else to report in this section
./examples/docs/exported_values/code_constructs/module/module_lib.ml:6: unit pattern unused
./examples/docs/exported_values/code_constructs/module/module_lib.ml:7: unit pattern unused_unexported

./examples/docs/exported_values/limitations/sigincl/sigincl_lib.ml:9: unit pattern x

./examples/using_dune/preprocessed_lib/preprocessed.ml:83: let () = ... in ... (=> use sequence)
./examples/using_dune/preprocessed_lib/preprocessed.ml:83: unit pattern unit_binding
./examples/using_dune/preprocessed_lib/preprocessed.ml:84: val f: ... -> (... -> ?_:_ -> ...) -> ...
Expand Down Expand Up @@ -1346,7 +1344,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 1138
Success: 1134
Failed: 4
Ratio: 99.6485061511%
Total: 1137
Success: 1132
Failed: 5
Ratio: 99.5602462621%
Loading