aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-09-29 20:13:00 -0400
committerBruce Hill <bruce@bruce-hill.com>2024-09-29 20:13:00 -0400
commitf03587be8d1001db0d9bf7fbd8be1f8f9c42d702 (patch)
tree1c7b737723b774453960cc4014618733e98bb917 /docs
parent05515d8645326efa3db6311f6be1be776452c68a (diff)
Document now()
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 364cd2ca..b04c3d0c 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -169,3 +169,28 @@ Nothing, aborts the program.
```markdown
fail("Oh no!")
```
+
+---
+
+### `now`
+
+**Description:**
+Gets the current time. This is an alias for `DateTime.now()`.
+
+**Usage:**
+```markdown
+now() -> DateTime
+```
+
+**Parameters:**
+
+None.
+
+**Returns:**
+The current moment as a DateTime.
+
+**Example:**
+```markdown
+>> now()
+= Sun Sep 29 20:12:33 2024
+```