added type alias documentation guide

coalton-lang · Oct 16, 2024 · fde68b5 · fde68b5
1 parent 314ff0b
commit fde68b5
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/coalton-documentation-guide.md b/docs/coalton-documentation-guide.md
@@ -33,6 +33,16 @@ that contains a filling of various sweet or savoury ingredients."
     (Meat String)  "A meat pie with the type of meat."))
 ```
 
+### `define-alias`
+
+`define-alias` allows for the same docstring style as `define`.
+
+```lisp
+(coalton-toplevel
+
+  (define-alias Index Integer
+    "This is an alias for a discrete numeric type: INTEGER"))
+
 ### `define-class`
 
 `define-class` allows for documentation both on the main form and in each method.