[docs][methods][12/n] add factory example and limitation

This shows that analyzing objects produced by factory functions is the
same as considering the function as its resulting object.

Author: fantazio

check/classic/classic.exp

@@ -25,8 +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/imm_obj/imm_obj_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
@@ -156,13 +161,19 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: 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/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
 
 ./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused
 
 ./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
 
@@ -588,6 +599,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: ... -> (... -> ?_:_ -> ...) -> ...

check/classic/classic.ref

@@ -30,8 +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/imm_obj/imm_obj_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
@@ -161,13 +166,19 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: 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/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
 
 ./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused
 
 ./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
 
@@ -593,6 +604,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: ... -> (... -> ?_:_ -> ...) -> ...
@@ -640,7 +654,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 547
-Success: 541
-Failed: 6
-Ratio: 98.9031078611%
+Total: 556
+Success: 549
+Failed: 7
+Ratio: 98.7410071942%

check/internal/internal.exp

@@ -15,8 +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/imm_obj/imm_obj_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
 
@@ -111,13 +116,19 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: 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/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
 
 ./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused
 
 ./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
 
@@ -543,6 +554,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: ... -> (... -> ?_:_ -> ...) -> ...

check/internal/internal.ref

@@ -20,8 +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/imm_obj/imm_obj_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
 
@@ -116,13 +121,19 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: 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/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
 
 ./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused
 
 ./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
 
@@ -548,6 +559,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: ... -> (... -> ?_:_ -> ...) -> ...
@@ -595,7 +609,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 505
-Success: 499
-Failed: 6
-Ratio: 98.8118811881%
+Total: 514
+Success: 507
+Failed: 7
+Ratio: 98.6381322957%

check/threshold-1/threshold-1.exp

@@ -15,8 +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/imm_obj/imm_obj_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
 
@@ -146,6 +151,9 @@
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:6: push_n_times
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:12: clear_stack
 
+./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:6: push_n_times
+./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:11: clear_stack
+
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
 
@@ -367,13 +375,19 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: 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/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
 
 ./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused
 
 ./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
 
@@ -444,6 +458,11 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: int_stack#pop
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: int_stack#push
 
+./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#is_empty
+./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/imm_obj/imm_obj_lib.mli:8: int_stack#peek
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
@@ -959,6 +978,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: ... -> (... -> ?_:_ -> ...) -> ...

check/threshold-1/threshold-1.ref

@@ -20,8 +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/imm_obj/imm_obj_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
 
@@ -151,6 +156,9 @@
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:6: push_n_times
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:12: clear_stack
 
+./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:6: push_n_times
+./examples/docs/methods/code_constructs/factory_fun/factory_fun_bin.ml:11: clear_stack
+
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:6: push_n_times
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_bin.ml:12: clear_stack
 
@@ -372,13 +380,19 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_bin.ml:2: unused_class#unused_method
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: 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/imm_obj/imm_obj_bin.ml:2: unused_obj#unused_method
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#reset
 
 ./examples/docs/methods/code_constructs/inheritance/inheritance_lib.mli:2: parent#unused
 
 ./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
 
@@ -449,6 +463,11 @@ Nothing else to report in this section
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: int_stack#pop
 ./examples/docs/methods/code_constructs/constructor/constructor_lib.mli:10: int_stack#push
 
+./examples/docs/methods/code_constructs/factory_fun/factory_fun_lib.mli:2: get_stack#is_empty
+./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/imm_obj/imm_obj_lib.mli:8: int_stack#peek
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#pop
 ./examples/docs/methods/code_constructs/imm_obj/imm_obj_lib.mli:8: int_stack#push
@@ -963,6 +982,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: ... -> (... -> ?_:_ -> ...) -> ...
@@ -1010,7 +1032,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 862
-Success: 855
-Failed: 7
-Ratio: 99.1879350348%
+Total: 877
+Success: 869
+Failed: 8
+Ratio: 99.0877993158%