docs: Add documentation for @deprecated

reconquest · Oct 11, 2023 · ac86b7d · ac86b7d
1 parent 25d8a97
commit ac86b7d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -191,6 +191,18 @@ function super() {
 }
 ```
 
+### `@deprecated`
+
+If the function is deprecated.
+
+**Example**
+```bash
+# @deprecated
+say-hello() {
+    ...
+}
+```
+
 ### `@section`
 
 The name of a section of the file. Can be used to group functions.