Update document of callbacks

wxh06 · Jul 16, 2020 · d9f6ed1 · d9f6ed1
1 parent 8615d75
commit d9f6ed1
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 7 deletions.
diff --git a/dockerjudge/__init__.py b/dockerjudge/__init__.py
@@ -66,13 +66,13 @@ def judge(processor, source, tests, config=None,
 
         Tese case
 
-        === ================================== =====================
-        Key Value type                         Description
-        === ================================== =====================
-        `0` :class:`dockerjudge.status.Status` Status code
-        `1` `tuple`                            `stdout` and `stderr`
-        `2` `float`                            Time used
-        === ================================== =====================
+        === =================================== =====================
+        Key Value type                          Description
+        === =================================== =====================
+        `0` :class:`~dockerjudge.status.Status` Status code
+        `1` `tuple`                             `stdout` and `stderr`
+        `2` `float`                             Time used
+        === =================================== =====================
     """
     config = config or {}
     container = client.containers.run(

diff --git a/docs/__init__.rst b/docs/__init__.rst
@@ -1,6 +1,35 @@
+=========================
 :mod:`dockerjudge` - Main
 =========================
 
 .. automodule:: dockerjudge
 
+Judge
+=====
+
 .. autofunction:: dockerjudge.judge
+
+Callback
+========
+
+Compile
+-------
+
+========= ================= =================================================
+Parameter Type              Description
+========= ================= =================================================
+`0`       `int`             Return value of the compiler
+`1`       `byte` or `tuple` Output of compiler, value type depends on `demux`
+========= ================= =================================================
+
+Judge
+-----
+
+========= =================================== ===============================
+Parameter Type                                Description
+========= =================================== ===============================
+`0`       `int`                               Test case id, starting from `0`
+`1`       :class:`~dockerjudge.status.Status` Status
+`2`       `tuple`                             Output `(stdout, stderr)`
+`3`       `float`                             Time used
+========= =================================== ===============================