Skip to content

Commit 0a8a50a

Browse files
committed
chore: update stdlib documentation
1 parent 25566a3 commit 0a8a50a

24 files changed

Lines changed: 468 additions & 46 deletions

content/docs/std/Async.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Async"
33
slug: "async"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

content/docs/std/Benchmark.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Benchmark"
33
slug: "benchmark"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

content/docs/std/Builtins.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Builtins"
33
slug: "builtins"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true
@@ -67,6 +67,25 @@ Get the type of a given value as a string
6767
(print (type false)) # "Bool"
6868
{{< /highlight_arkscript >}}
6969

70+
## assert
71+
72+
---
73+
`(assert cond message)`
74+
Interrupt the execution if a given condition is false
75+
76+
77+
78+
#### Parameters
79+
- `cond`: condition
80+
- `message`: string to display
81+
82+
83+
#### Example
84+
{{< highlight_arkscript >}}
85+
(let a 5)
86+
(assert (>= a 4) "'a' must be at least 4")
87+
{{< /highlight_arkscript >}}
88+
7089
## nil?
7190

7291
---

content/docs/std/Bytecode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Bytecode"
33
slug: "bytecode"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

content/docs/std/Cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Cli"
33
slug: "cli"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

content/docs/std/Dict.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Dict"
33
slug: "dict"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true
@@ -250,6 +250,8 @@ Returns a list of the keys of a dictionary
250250
`(let size (fun (_D) (...)))`
251251
Computes the number of (key, value) pairs in a given dictionary
252252

253+
**Deprecated**: Use the builtin `len` instead
254+
253255

254256
**Author**: [@SuperFola](https://github.com/SuperFola)
255257

content/docs/std/Events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Events"
33
slug: "events"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

content/docs/std/Exceptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Exceptions"
33
slug: "exceptions"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

content/docs/std/Functional.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Functional"
33
slug: "functional"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

content/docs/std/IO.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "IO"
33
slug: "io"
44
description: ""
55
summary: ""
6-
date: 2026-02-10T17:29:49+02:00
7-
lastmod: 2026-02-10T17:29:49+02:00
6+
date: 2026-02-28T12:09:01+02:00
7+
lastmod: 2026-02-28T12:09:01+02:00
88
draft: false
99
weight: 410
1010
toc: true

0 commit comments

Comments
 (0)