Skip to content

Add doc for methods #68

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

Open
fantazio wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Add doc for methods #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2cd0326
[docs][methods][1/n] initial documentation
fantazio Mar 17, 2026
7261c0d
[docs][methods][2/n] add immediate object example
fantazio Mar 19, 2026
b747780
[docs][methods][3/n] add class example
fantazio Mar 20, 2026
95dc65f
[docs][methods][4/n] add class type example
fantazio Mar 20, 2026
79cfe49
[docs][methods][5/n] add inheritance example
fantazio Mar 23, 2026
ce2dfce
[docs][methods][6/n] add limitations section
fantazio Mar 23, 2026
b23171f
[docs][methods][7/n] add object type example
fantazio Mar 23, 2026
78fd861
[docs][methods][8/n] add constructor example
fantazio Mar 23, 2026
50b0bc6
[docs][methods][9/n] reorder examples
fantazio Mar 23, 2026
64a4324
[docs][methods][10/n] add alias limitation
fantazio Mar 23, 2026
065cbeb
[docs][methods][11/n] add coercion example
fantazio Mar 23, 2026
79544cf
[docs][methods][12/n] add factory example and limitation
fantazio Mar 24, 2026
7c62ec1
[docs][methods][13/n] add polymorphic class example
fantazio Mar 24, 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
33 changes: 33 additions & 0 deletions check/classic/classic.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@
./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/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory

./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 @@ -146,6 +153,29 @@ Nothing else to report in this section

.> UNUSED METHODS:
=================
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/coercion/coercion_lib.mli:2: obj#unused

./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory#unused_method
./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#reset

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj#unused_method
./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused

./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#reset

./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#unused

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding#m
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory#m

./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused

Expand Down Expand Up @@ -571,6 +601,9 @@ Nothing else to report in this section

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

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:3: let x = ... in x (=> useless binding)
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:12: let x = ... in x (=> useless binding)

./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
41 changes: 37 additions & 4 deletions check/classic/classic.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@
./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/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory

./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 @@ -151,6 +158,29 @@ Nothing else to report in this section

.> UNUSED METHODS:
=================
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/coercion/coercion_lib.mli:2: obj#unused

./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory#unused_method
./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#reset

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj#unused_method
./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused

./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#reset

./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#unused
./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#used_by_alias: Should not be detected
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding#m: Not detected
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory#m

./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused

Expand Down Expand Up @@ -576,6 +606,9 @@ Nothing else to report in this section

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

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:3: let x = ... in x (=> useless binding)
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:12: let x = ... in x (=> useless binding)

./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 @@ -623,7 +656,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 536
Success: 531
Failed: 5
Ratio: 99.0671641791%
Total: 557
Success: 550
Failed: 7
Ratio: 98.7432675045%
33 changes: 33 additions & 0 deletions check/internal/internal.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@

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

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory

./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused

Expand Down Expand Up @@ -101,6 +108,29 @@ Nothing else to report in this section

.> UNUSED METHODS:
=================
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/coercion/coercion_lib.mli:2: obj#unused

./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory#unused_method
./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#reset

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj#unused_method
./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused

./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#reset

./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#unused

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding#m
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory#m

./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused

Expand Down Expand Up @@ -526,6 +556,9 @@ Nothing else to report in this section

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

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:3: let x = ... in x (=> useless binding)
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:12: let x = ... in x (=> useless binding)

./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
41 changes: 37 additions & 4 deletions check/internal/internal.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@
./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/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory

./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused

Expand Down Expand Up @@ -106,6 +113,29 @@ Nothing else to report in this section

.> UNUSED METHODS:
=================
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/coercion/coercion_lib.mli:2: obj#unused

./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory#unused_method
./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#reset

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj#unused_method
./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused

./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#reset

./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#unused
./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#used_by_alias: Should not be detected
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding#m: Not detected
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory#m

./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused

Expand Down Expand Up @@ -531,6 +561,9 @@ Nothing else to report in this section

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

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:3: let x = ... in x (=> useless binding)
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:12: let x = ... in x (=> useless binding)

./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 @@ -578,7 +611,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 494
Success: 489
Failed: 5
Ratio: 98.987854251%
Total: 515
Success: 508
Failed: 7
Ratio: 98.640776699%
79 changes: 79 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 @@ -15,6 +15,13 @@

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

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory

./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused

Expand Down Expand Up @@ -133,6 +140,24 @@
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:2: hello
./examples/docs/exported_values/hello_world/hello_world_without_intf.ml:3: goodbye

./examples/docs/methods/code_constructs/class/class_bin.ml:4: push_n_times

./examples/docs/methods/code_constructs/class_type/class_type_bin.ml:4: push_n_times

./examples/docs/methods/code_constructs/coercion/coercion_lib.mli:2: obj

./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:4: push_n_times

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:4: push_n_times

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:4: push_n_times

./examples/docs/methods/code_constructs/object_type/object_type_bin.ml:4: push_n_times

./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_bin.ml:2: push_n_times

./examples/docs/methods/limitations/alias/alias_lib.mli:8: alias

./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed.mli:1: mark_used
./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_lib.mli:1: mark_used
./examples/using_dune/bin/use_preprocessed_lib/use_preprocessed_no_intf.mli:1: mark_used
Expand Down Expand Up @@ -338,6 +363,29 @@ Nothing else to report in this section

.> UNUSED METHODS:
=================
./examples/docs/methods/code_constructs/class/class_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/coercion/coercion_lib.mli:2: obj#unused

./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:2: unused_factory#unused_method
./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#reset

./examples/docs/methods/code_constructs/immediate_object/immediate_object_bin.ml:2: unused_obj#unused_method
./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#reset

./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused

./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#reset

./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#unused

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:2: factory_with_intermediate_binding#m
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:8: random_factory#m

./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#unused
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#unused

Expand Down Expand Up @@ -398,6 +446,34 @@ Nothing else to report in this section

.>-> ALMOST UNUSED METHODS: Called 1 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#peek
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#pop
./examples/docs/methods/code_constructs/class/class_lib.mli:2: int_stack#push

./examples/docs/methods/code_constructs/coercion/coercion_lib.mli:2: obj#used_by_requirement

./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#peek
./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#pop
./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:2: int_stack#push

./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#peek
./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#pop
./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#push

./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#peek
./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#pop
./examples/docs/methods/code_constructs/immediate_object/immediate_object_lib.mli:2: int_stack#push

./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#used
./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#used_by_child

./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#peek
./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#pop
./examples/docs/methods/code_constructs/polymorphic_class/polymorphic_class_lib.mli:2: stack#push

./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#used
./examples/docs/methods/limitations/alias/alias_lib.mli:2: original#used_by_alias

./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#externally_used
./examples/using_dune/preprocessed_lib/preprocessed.mli:6: immediate#internally_used
./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:12: immediate#externally_used
Expand Down Expand Up @@ -903,6 +979,9 @@ Nothing else to report in this section

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

./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:3: let x = ... in x (=> useless binding)
./examples/docs/methods/limitations/factory_fun_indir/factory_fun_indir.ml:12: let x = ... in x (=> useless binding)

./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
Loading