add documentation to theorem-function

Marmare314 · Sep 30, 2023 · 5edf2e1 · 5edf2e1
1 parent 6cc446c
commit 5edf2e1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/function-types.typ b/docs/function-types.typ
@@ -1,6 +1,8 @@
 #let theorem-kind = (link-to: 0, numbering: 0)
 
-/// TODO
+/// The functions that actually create the theorems.
+/// The default values of the arguments are set to the
+/// values provided in @@theorem-kind() or @@default-theorems.
 ///
 /// - name (content, str): The name of the #ref-type("theorem").
 /// - link-to (label, selector, selector-function, none): Link the #ref-type("theorem")

diff --git a/docs/readme.pdf b/docs/readme.pdf