Skip to content

Add doc for coding style #73

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 7 commits into from
Apr 13, 2026
Merged

Add doc for coding style #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
43dd185
[docs][style][1/n] initial documentation
fantazio Apr 8, 2026
4e2adf3
[docs][style][2/n] add bind section
fantazio Apr 8, 2026
c49c874
[docs][style][3/n] add opt section
fantazio Apr 8, 2026
d38f78a
[docs][style][4/n] add seq section
fantazio Apr 9, 2026
45808f1
[docs][style][5/n] add unit section
fantazio Apr 9, 2026
963d8fe
[src][deadCode] improve unit binding issue report
fantazio Apr 9, 2026
139ba16
[docs][style][6/n] fix typos and wordings
fantazio Apr 13, 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
21 changes: 21 additions & 0 deletions check/classic/classic.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
.> UNUSED EXPORTED VALUES:
=========================
./examples/docs/coding_style/bind/bind.ml:2: v

./examples/docs/coding_style/opt/opt.ml:14: add_index_to_negative

./examples/docs/coding_style/seq/seq.ml:2: compute_answer

./examples/docs/coding_style/unit/unit.ml:2: compute_answer

./examples/docs/exported_values/code_constructs/function/function_lib.mli:7: unused

./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:9: F.internally_used
Expand Down Expand Up @@ -325,6 +333,8 @@ Nothing else to report in this section

.> OPTIONAL ARGUMENTS: ALWAYS:
=============================
./examples/docs/coding_style/opt/opt.ml:15: ?index

./examples/docs/optional_arguments/code_constructs/external_app/external_app_lib.mli:3: ?max

./examples/docs/optional_arguments/code_constructs/hof/hof_bin.ml:2: ?index
Expand Down Expand Up @@ -613,6 +623,17 @@ Nothing else to report in this section

.> CODING STYLE:
===============
./examples/docs/coding_style/bind/bind.ml:3: let x = ... in x (=> useless binding)

./examples/docs/coding_style/opt/opt.ml:2: val f: ... -> (... -> ?_:_ -> ...) -> ...

./examples/docs/coding_style/seq/seq.ml:3: let () = ... in ... (=> use sequence)

./examples/docs/coding_style/unit/unit.ml:2: unit pattern input
./examples/docs/coding_style/unit/unit.ml:3: let () = ... in ... (=> use sequence)
./examples/docs/coding_style/unit/unit.ml:3: unit pattern print
./examples/docs/coding_style/unit/unit.ml:5: unit pattern r

./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:16: unit pattern used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:17: unit pattern unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:21: unit pattern used_required
Expand Down
27 changes: 24 additions & 3 deletions check/classic/classic.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
.> UNUSED EXPORTED VALUES:
=========================
./examples/docs/coding_style/bind/bind.ml:2: v

./examples/docs/coding_style/opt/opt.ml:14: add_index_to_negative

./examples/docs/coding_style/seq/seq.ml:2: compute_answer

./examples/docs/coding_style/unit/unit.ml:2: compute_answer

./examples/docs/exported_values/code_constructs/function/function_lib.mli:7: unused

./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:9: F.internally_used
Expand Down Expand Up @@ -330,6 +338,8 @@ Nothing else to report in this section

.> OPTIONAL ARGUMENTS: ALWAYS:
=============================
./examples/docs/coding_style/opt/opt.ml:15: ?index

./examples/docs/optional_arguments/code_constructs/external_app/external_app_lib.mli:3: ?max

./examples/docs/optional_arguments/code_constructs/hof/hof_bin.ml:2: ?index
Expand Down Expand Up @@ -618,6 +628,17 @@ Nothing else to report in this section

.> CODING STYLE:
===============
./examples/docs/coding_style/bind/bind.ml:3: let x = ... in x (=> useless binding)

./examples/docs/coding_style/opt/opt.ml:2: val f: ... -> (... -> ?_:_ -> ...) -> ...

./examples/docs/coding_style/seq/seq.ml:3: let () = ... in ... (=> use sequence)

./examples/docs/coding_style/unit/unit.ml:2: unit pattern input
./examples/docs/coding_style/unit/unit.ml:3: let () = ... in ... (=> use sequence)
./examples/docs/coding_style/unit/unit.ml:3: unit pattern print
./examples/docs/coding_style/unit/unit.ml:5: unit pattern r

./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:16: unit pattern used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:17: unit pattern unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:21: unit pattern used_required
Expand Down Expand Up @@ -698,7 +719,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 581
Success: 574
Total: 593
Success: 586
Failed: 7
Ratio: 98.7951807229%
Ratio: 98.8195615514%
21 changes: 21 additions & 0 deletions check/internal/internal.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
.> UNUSED EXPORTED VALUES:
=========================
./examples/docs/coding_style/bind/bind.ml:2: v

./examples/docs/coding_style/opt/opt.ml:14: add_index_to_negative

./examples/docs/coding_style/seq/seq.ml:2: compute_answer

./examples/docs/coding_style/unit/unit.ml:2: compute_answer

./examples/docs/exported_values/code_constructs/function/function_lib.mli:7: unused

./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:10: F.unused
Expand Down Expand Up @@ -277,6 +285,8 @@ Nothing else to report in this section

.> OPTIONAL ARGUMENTS: ALWAYS:
=============================
./examples/docs/coding_style/opt/opt.ml:15: ?index

./examples/docs/optional_arguments/code_constructs/external_app/external_app_lib.mli:3: ?max

./examples/docs/optional_arguments/code_constructs/hof/hof_bin.ml:2: ?index
Expand Down Expand Up @@ -565,6 +575,17 @@ Nothing else to report in this section

.> CODING STYLE:
===============
./examples/docs/coding_style/bind/bind.ml:3: let x = ... in x (=> useless binding)

./examples/docs/coding_style/opt/opt.ml:2: val f: ... -> (... -> ?_:_ -> ...) -> ...

./examples/docs/coding_style/seq/seq.ml:3: let () = ... in ... (=> use sequence)

./examples/docs/coding_style/unit/unit.ml:2: unit pattern input
./examples/docs/coding_style/unit/unit.ml:3: let () = ... in ... (=> use sequence)
./examples/docs/coding_style/unit/unit.ml:3: unit pattern print
./examples/docs/coding_style/unit/unit.ml:5: unit pattern r

./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:16: unit pattern used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:17: unit pattern unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:21: unit pattern used_required
Expand Down
27 changes: 24 additions & 3 deletions check/internal/internal.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
.> UNUSED EXPORTED VALUES:
=========================
./examples/docs/coding_style/bind/bind.ml:2: v

./examples/docs/coding_style/opt/opt.ml:14: add_index_to_negative

./examples/docs/coding_style/seq/seq.ml:2: compute_answer

./examples/docs/coding_style/unit/unit.ml:2: compute_answer

./examples/docs/exported_values/code_constructs/function/function_lib.mli:7: unused

./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:10: F.unused
Expand Down Expand Up @@ -282,6 +290,8 @@ Nothing else to report in this section

.> OPTIONAL ARGUMENTS: ALWAYS:
=============================
./examples/docs/coding_style/opt/opt.ml:15: ?index

./examples/docs/optional_arguments/code_constructs/external_app/external_app_lib.mli:3: ?max

./examples/docs/optional_arguments/code_constructs/hof/hof_bin.ml:2: ?index
Expand Down Expand Up @@ -570,6 +580,17 @@ Nothing else to report in this section

.> CODING STYLE:
===============
./examples/docs/coding_style/bind/bind.ml:3: let x = ... in x (=> useless binding)

./examples/docs/coding_style/opt/opt.ml:2: val f: ... -> (... -> ?_:_ -> ...) -> ...

./examples/docs/coding_style/seq/seq.ml:3: let () = ... in ... (=> use sequence)

./examples/docs/coding_style/unit/unit.ml:2: unit pattern input
./examples/docs/coding_style/unit/unit.ml:3: let () = ... in ... (=> use sequence)
./examples/docs/coding_style/unit/unit.ml:3: unit pattern print
./examples/docs/coding_style/unit/unit.ml:5: unit pattern r

./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:16: unit pattern used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:17: unit pattern unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:21: unit pattern used_required
Expand Down Expand Up @@ -650,7 +671,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 537
Success: 530
Total: 549
Success: 542
Failed: 7
Ratio: 98.696461825%
Ratio: 98.7249544627%
23 changes: 23 additions & 0 deletions check/threshold-1/threshold-1.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
.> UNUSED EXPORTED VALUES:
=========================
./examples/docs/coding_style/bind/bind.ml:2: v

./examples/docs/coding_style/opt/opt.ml:14: add_index_to_negative

./examples/docs/coding_style/seq/seq.ml:2: compute_answer

./examples/docs/coding_style/unit/unit.ml:2: compute_answer

./examples/docs/exported_values/code_constructs/function/function_lib.mli:7: unused

./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:10: F.unused
Expand Down Expand Up @@ -108,6 +116,8 @@

.>-> ALMOST UNUSED EXPORTED VALUES: Called 1 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/coding_style/opt/opt.ml:2: map_with_index_on_negative

./examples/docs/exported_values/code_constructs/function/function_lib.mli:3: memoize
./examples/docs/exported_values/code_constructs/function/function_lib.mli:5: heavy_computation
./examples/docs/exported_values/code_constructs/function/function_lib.mli:9: do_nothing
Expand Down Expand Up @@ -732,6 +742,8 @@ Nothing else to report in this section

.> OPTIONAL ARGUMENTS: ALWAYS:
=============================
./examples/docs/coding_style/opt/opt.ml:15: ?index

./examples/docs/optional_arguments/code_constructs/external_app/external_app_lib.mli:3: ?max

./examples/docs/optional_arguments/code_constructs/hof/hof_bin.ml:2: ?index
Expand Down Expand Up @@ -1020,6 +1032,17 @@ Nothing else to report in this section

.> CODING STYLE:
===============
./examples/docs/coding_style/bind/bind.ml:3: let x = ... in x (=> useless binding)

./examples/docs/coding_style/opt/opt.ml:2: val f: ... -> (... -> ?_:_ -> ...) -> ...

./examples/docs/coding_style/seq/seq.ml:3: let () = ... in ... (=> use sequence)

./examples/docs/coding_style/unit/unit.ml:2: unit pattern input
./examples/docs/coding_style/unit/unit.ml:3: let () = ... in ... (=> use sequence)
./examples/docs/coding_style/unit/unit.ml:3: unit pattern print
./examples/docs/coding_style/unit/unit.ml:5: unit pattern r

./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:16: unit pattern used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:17: unit pattern unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:21: unit pattern used_required
Expand Down
29 changes: 26 additions & 3 deletions check/threshold-1/threshold-1.ref
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
.> UNUSED EXPORTED VALUES:
=========================
./examples/docs/coding_style/bind/bind.ml:2: v

./examples/docs/coding_style/opt/opt.ml:14: add_index_to_negative

./examples/docs/coding_style/seq/seq.ml:2: compute_answer

./examples/docs/coding_style/unit/unit.ml:2: compute_answer

./examples/docs/exported_values/code_constructs/function/function_lib.mli:7: unused

./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:10: F.unused
Expand Down Expand Up @@ -113,6 +121,8 @@

.>-> ALMOST UNUSED EXPORTED VALUES: Called 1 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/coding_style/opt/opt.ml:2: map_with_index_on_negative

./examples/docs/exported_values/code_constructs/function/function_lib.mli:3: memoize
./examples/docs/exported_values/code_constructs/function/function_lib.mli:5: heavy_computation
./examples/docs/exported_values/code_constructs/function/function_lib.mli:9: do_nothing
Expand Down Expand Up @@ -736,6 +746,8 @@ Nothing else to report in this section

.> OPTIONAL ARGUMENTS: ALWAYS:
=============================
./examples/docs/coding_style/opt/opt.ml:15: ?index

./examples/docs/optional_arguments/code_constructs/external_app/external_app_lib.mli:3: ?max

./examples/docs/optional_arguments/code_constructs/hof/hof_bin.ml:2: ?index
Expand Down Expand Up @@ -1024,6 +1036,17 @@ Nothing else to report in this section

.> CODING STYLE:
===============
./examples/docs/coding_style/bind/bind.ml:3: let x = ... in x (=> useless binding)

./examples/docs/coding_style/opt/opt.ml:2: val f: ... -> (... -> ?_:_ -> ...) -> ...

./examples/docs/coding_style/seq/seq.ml:3: let () = ... in ... (=> use sequence)

./examples/docs/coding_style/unit/unit.ml:2: unit pattern input
./examples/docs/coding_style/unit/unit.ml:3: let () = ... in ... (=> use sequence)
./examples/docs/coding_style/unit/unit.ml:3: unit pattern print
./examples/docs/coding_style/unit/unit.ml:5: unit pattern r

./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:16: unit pattern used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:17: unit pattern unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:21: unit pattern used_required
Expand Down Expand Up @@ -1104,7 +1127,7 @@ Nothing else to report in this section
--------------------------------------------------------------------------------


Total: 916
Success: 908
Total: 929
Success: 921
Failed: 8
Ratio: 99.1266375546%
Ratio: 99.1388589882%
27 changes: 27 additions & 0 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
@@ -1,5 +1,13 @@
.> UNUSED EXPORTED VALUES:
=========================
./examples/docs/coding_style/bind/bind.ml:2: v

./examples/docs/coding_style/opt/opt.ml:14: add_index_to_negative

./examples/docs/coding_style/seq/seq.ml:2: compute_answer

./examples/docs/coding_style/unit/unit.ml:2: compute_answer

./examples/docs/exported_values/code_constructs/function/function_lib.mli:7: unused

./examples/docs/exported_values/code_constructs/functor/functor_lib.mli:10: F.unused
Expand Down Expand Up @@ -108,6 +116,8 @@

.>-> ALMOST UNUSED EXPORTED VALUES: Called 1 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/coding_style/opt/opt.ml:2: map_with_index_on_negative

./examples/docs/exported_values/code_constructs/function/function_lib.mli:3: memoize
./examples/docs/exported_values/code_constructs/function/function_lib.mli:5: heavy_computation
./examples/docs/exported_values/code_constructs/function/function_lib.mli:9: do_nothing
Expand Down Expand Up @@ -957,6 +967,8 @@ Nothing else to report in this section

.> OPTIONAL ARGUMENTS: ALWAYS:
=============================
./examples/docs/coding_style/opt/opt.ml:15: ?index

./examples/docs/optional_arguments/code_constructs/external_app/external_app_lib.mli:3: ?max

./examples/docs/optional_arguments/code_constructs/hof/hof_bin.ml:2: ?index
Expand Down Expand Up @@ -1116,6 +1128,8 @@ Nothing else to report in this section

.>-> OPTIONAL ARGUMENTS: ALMOST ALWAYS: Except 1 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/coding_style/opt/opt.ml:2: ?index (1/2 calls)

./examples/using_dune/preprocessed_lib/preprocessed.ml:59: ?sometimes (1/2 calls)
./examples/using_dune/preprocessed_lib/preprocessed.ml:64: ?sometimes (1/2 calls)
./examples/using_dune/preprocessed_lib/preprocessed.mli:44: ?sometimes (1/2 calls)
Expand Down Expand Up @@ -1341,6 +1355,8 @@ Nothing else to report in this section

.>-> OPTIONAL ARGUMENTS: ALMOST NEVER: Except 1 time(s):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
./examples/docs/coding_style/opt/opt.ml:2: ?index (1/2 calls)

./examples/using_dune/preprocessed_lib/preprocessed.ml:59: ?sometimes (1/2 calls)
./examples/using_dune/preprocessed_lib/preprocessed.ml:64: ?sometimes (1/2 calls)
./examples/using_dune/preprocessed_lib/preprocessed.mli:44: ?sometimes (1/2 calls)
Expand Down Expand Up @@ -1424,6 +1440,17 @@ Nothing else to report in this section

.> CODING STYLE:
===============
./examples/docs/coding_style/bind/bind.ml:3: let x = ... in x (=> useless binding)

./examples/docs/coding_style/opt/opt.ml:2: val f: ... -> (... -> ?_:_ -> ...) -> ...

./examples/docs/coding_style/seq/seq.ml:3: let () = ... in ... (=> use sequence)

./examples/docs/coding_style/unit/unit.ml:2: unit pattern input
./examples/docs/coding_style/unit/unit.ml:3: let () = ... in ... (=> use sequence)
./examples/docs/coding_style/unit/unit.ml:3: unit pattern print
./examples/docs/coding_style/unit/unit.ml:5: unit pattern r

./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:16: unit pattern used_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:17: unit pattern unused_required
./examples/docs/exported_values/code_constructs/functor/functor_lib.ml:21: unit pattern used_required
Expand Down
Loading