aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJJ2024-01-28 09:30:11 +0000
committerJJ2024-01-28 09:30:11 +0000
commita409dd7ea7d6d363d5ef971526b81d95e6add51d (patch)
treeb4442be61b839482766a132534f2f4ae5f88fa11
parentba8ce3875d09b88463da76148ba5d563049b089f (diff)
docs: add notices of caution to incomplete sections
-rw-r--r--docs/ASYNC.md2
-rw-r--r--docs/INTEROP.md2
-rw-r--r--docs/MODULES.md2
-rw-r--r--docs/TYPES.md2
4 files changed, 8 insertions, 0 deletions
diff --git a/docs/ASYNC.md b/docs/ASYNC.md
index 87c602d..28a69da 100644
--- a/docs/ASYNC.md
+++ b/docs/ASYNC.md
@@ -1,5 +1,7 @@
# Asynchronous Programming
+> ! This section is a **draft**. Many important details have yet to be ironed out.
+
Puck has [colourless](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function/) async/await, heavily inspired by [Zig's implementation](https://kristoff.it/blog/zig-colorblind-async-await/).
```puck
diff --git a/docs/INTEROP.md b/docs/INTEROP.md
index f595afa..7eaed5f 100644
--- a/docs/INTEROP.md
+++ b/docs/INTEROP.md
@@ -1,5 +1,7 @@
# Interop with Other Languages
+> ! This section is a **draft**. Many important details have yet to be ironed out.
+
A major goal of Puck is _minimal-overhead language interoperability_ while maintaining type safety.
There are three issues that complicate language interop:
diff --git a/docs/MODULES.md b/docs/MODULES.md
index bbce909..938e47e 100644
--- a/docs/MODULES.md
+++ b/docs/MODULES.md
@@ -1,5 +1,7 @@
# Modules and Namespacing
+> ! This section is **incomplete**. Proceed with caution.
+
Puck has a first-class module system, inspired by such expressive designs in the ML family.
## Using Modules
diff --git a/docs/TYPES.md b/docs/TYPES.md
index f666ce8..17d5d6a 100644
--- a/docs/TYPES.md
+++ b/docs/TYPES.md
@@ -1,5 +1,7 @@
# Typing in Puck
+> ! This section **needs a rewrite**. Proceed with low standards.
+
Puck has a comprehensive static type system, inspired by the likes of Nim, Rust, and Swift.
## Basic types