Skip to content

Try to fix the #526 documentation issue #607

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.

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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion src/grader-plugins/mutation_test.mli
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Learn-OCaml is distributed under the terms of the MIT license. See the
* included LICENSE file for details. *)

(* This module provides functions for automatically grading
(** This module provides functions for automatically grading
a student's unit tests using *mutation testing*.

A student's tests for a function [foo] are run against several
Expand Down
6 changes: 6 additions & 0 deletions src/grader/dune
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
(library
(name learnocaml_report)
(public_name learn-ocaml.report)
(wrapped false)
(flags :standard -w -37-41 -warn-error -27-39)
(modules Learnocaml_report)
Expand All @@ -18,6 +19,7 @@
;; parts (Grading) and dynamic parts (Test_lib)
(library
(name introspection_intf)
(public_name learn-ocaml.introspection_intf)
(wrapped false)
(modules introspection_intf)
(modules_without_implementation introspection_intf)
Expand All @@ -26,6 +28,7 @@
;; dynamic part, on which Test_lib depends
(library
(name pre_test)
(public_name learn-ocaml.pre_test)
(wrapped false)
(modules learnocaml_callback learnocaml_internal pre_test)
(modules_without_implementation learnocaml_callback learnocaml_internal pre_test)
Expand All @@ -37,6 +40,7 @@
;; dynamic (but pre-compiled) part
(library
(name testing_dyn)
(public_name learn-ocaml.test_lib)
(wrapped false)
(modes byte)
(library_flags :standard -linkall)
Expand Down Expand Up @@ -157,6 +161,7 @@

(library
(name embedded_cmis)
(public_name learn-ocaml.embedded_cmis)
(wrapped false)
(modes byte)
(modules Embedded_cmis)
Expand All @@ -181,6 +186,7 @@

(library
(name grading)
(public_name learn-ocaml.grading)
(wrapped false)
(modes byte)
(library_flags :standard -linkall)
Expand Down
5 changes: 5 additions & 0 deletions src/grader/learnocaml_report.mli
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
* Learn-OCaml is distributed under the terms of the MIT license. See the
* included LICENSE file for details. *)

(** Documentation for learn-ocaml's [report] library.
The [Learnocaml_report] module defines an AST for grading reports
generated by [Test_lib] functions. Supports both HTML output and
raw text output. *)

(** {2 Formatted report output} *)

type t = item list
Expand Down
4 changes: 2 additions & 2 deletions src/grader/test_lib.mli
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
* Learn-OCaml is distributed under the terms of the MIT license. See the
* included LICENSE file for details. *)

(** Documentation for [test_lib] library. [Test_lib] module can be
used to write graders for learn-ocaml. *)
(** Documentation for learn-ocaml's [test_lib] library.
The [Test_lib] module can be used to write graders for learn-ocaml. *)

val set_result : Learnocaml_report.t -> unit

Expand Down
3 changes: 2 additions & 1 deletion src/index.mld
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ forming the engine for the learn-ocaml platform, and the common files.

{1 List of documented modules}

Modules documentation could be found here:
The documentation of the main modules can be found here:

{ul
{li {{: Test_lib/index.html} [Test_lib]}}
{li {{: Learnocaml_report/index.html} [Learnocaml_report]}}
{li {{: Mutation_test/index.html} [Mutation_test]}}
}
6 changes: 6 additions & 0 deletions src/ppx-metaquot/dune
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
(library
(name ast_convenience)
(public_name learn-ocaml.ast_convenience)
(modules Ast_convenience)
(preprocess (action (run %{bin:cppo} -V OCAML:%{ocaml_version} %{input-file})))
(libraries compiler-libs.common)
Expand All @@ -21,6 +22,7 @@

(library
(name learnocaml_ppx_metaquot_lib)
(public_name learn-ocaml.ppx_metaquot_lib)
(wrapped false)
(flags :standard -w -17)
(library_flags :standard -linkall)
Expand All @@ -30,6 +32,7 @@

(library
(name ppx_autoregister)
(public_name learn-ocaml.ppx_autoregister)
(wrapped false)
(libraries ppxlib)
(modules Ppx_autoregister Printer_recorder))
Expand All @@ -44,6 +47,7 @@

(library
(name grader_ppx)
(public_name learn-ocaml.grader_ppx)
(wrapped false)
(libraries learnocaml_ppx_metaquot_lib ty fun_ty ppx_autoregister)
(modules Sampler_recorder Grader_ppx)
Expand All @@ -69,6 +73,7 @@

(library
(name ty)
(public_name learn-ocaml.ty)
(wrapped false)
(library_flags :standard -linkall)
(modules Ty)
Expand All @@ -77,6 +82,7 @@

(library
(name fun_ty)
(public_name learn-ocaml.fun_ty)
(wrapped false)
(library_flags :standard -linkall)
(modules Fun_ty)
Expand Down
1 change: 1 addition & 0 deletions src/repo/dune
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
(library
(name learnocaml_repository)
(public_name learn-ocaml.repository)
(wrapped false)
(modules Learnocaml_index
Learnocaml_exercise)
Expand Down
2 changes: 2 additions & 0 deletions src/toplevel/dune
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

(library
(name learnocaml_internal_intf)
(public_name learn-ocaml.internal_intf)
(wrapped false)
(modules learnocaml_internal_intf)
(modules_without_implementation learnocaml_internal_intf)
Expand Down Expand Up @@ -44,6 +45,7 @@

(library
(name learnocaml_toplevel_pp)
(public_name learn-ocaml.toplevel_pp)
(wrapped false)
(modes byte)
(libraries vg gg vg.svg)
Expand Down
2 changes: 2 additions & 0 deletions src/toploop/dune
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
(library
(name toploop_results)
(public_name learn-ocaml.toploop_results)
(wrapped false)
(modules Toploop_results)
(libraries compiler-libs.toplevel)
)

(library
(name toploop)
(public_name learn-ocaml.toploop)
(wrapped false)
(modes byte)
(modules Toploop_ext)
Expand Down
1 change: 1 addition & 0 deletions src/utils/dune
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

(library
(name ocplib_i18n)
(public_name learn-ocaml.i18n)
(wrapped false)
(flags :standard -warn-error -4-42-44-45-48)
(preprocess (pps ppx_ocplib_i18n))
Expand Down
Loading