summaryrefslogtreecommitdiff
path: root/docs/type_system
diff options
context:
space:
mode:
authornodist <kevin.comas.git@gmail.com>2026-06-11 12:08:10 -0400
committernodist <kevin.comas.git@gmail.com>2026-06-11 12:08:10 -0400
commit20a19f433956f063d8048f032aaf5dcce1d61e7c (patch)
treec9720211c62e75a245c252c82f6353e5162fcb86 /docs/type_system
parent51d055dc7e1a6edbaedb7ea80b1e678eff924fe0 (diff)
add algo for mutating shared object
Diffstat (limited to 'docs/type_system')
-rw-r--r--docs/type_system/function.md10
-rw-r--r--docs/type_system/index.md4
-rw-r--r--docs/type_system/namespace.md6
-rw-r--r--docs/type_system/shared.md6
-rw-r--r--docs/type_system/value.md2
5 files changed, 13 insertions, 15 deletions
diff --git a/docs/type_system/function.md b/docs/type_system/function.md
index d0fabc5..d8244a9 100644
--- a/docs/type_system/function.md
+++ b/docs/type_system/function.md
@@ -3,15 +3,19 @@
---
```text
-KIND : UNKNOWN | INCOMPLETE | NATIVE | TASK | PROCESS | GENERATOR | ITERATOR | CLOSURE | BOUND | REGEX
+INVOCATION : UNKNOWN | SYNC | ASYNC
-Function[[KIND] STATE; List; RETURN_TYPE; Collection[TYPE.SYMBOL]]
+CLASS : INCOMPLETE | NATIVE | TASK | PROCESS | GENERATOR | ITERATOR | CLOSURE | BOUND | REGEX
+
+FLAGS : INVOCATION | CLASS
+
+Function[[FLAGS] STATE; List; RETURN_TYPE; Collection[TYPE.SYMBOL]]
```
# Alias
```text
-Fn[Generic.T; Collection[TYPE.SYMBOL]] `alias Function[[KIND]; STATE; List; Generic.T; Collection[TYPE.SYMBOL]]
+Fn[Generic.T; Collection[TYPE.SYMBOL]] `alias Function[[FLAGS]; STATE; List; Generic.T; Collection[TYPE.SYMBOL]]
```
# Inline Definition
diff --git a/docs/type_system/index.md b/docs/type_system/index.md
index ae574d9..2d9e9c2 100644
--- a/docs/type_system/index.md
+++ b/docs/type_system/index.md
@@ -32,7 +32,7 @@ Template[[] Field; ...]
If a field in a template is not filed, one of these are required:
-### Any
+## Any
Denotes a field in a template that has not resolved
@@ -48,7 +48,7 @@ A list of types with shape of TYPE, only can have one collection per type
If using a collection the Collection[TYPE] must be the last type on the templates type list
-### Void
+## Void
Denotes that a field that does not resolve to anything
diff --git a/docs/type_system/namespace.md b/docs/type_system/namespace.md
index 9243280..9ae61ba 100644
--- a/docs/type_system/namespace.md
+++ b/docs/type_system/namespace.md
@@ -3,11 +3,9 @@
---
```text
-Namespace[[NATIVE | FILE] NAMESPACE_IDENTIFIER]
+Namespace[[NATIVE | MODULE] NAMESPACE_IDENTIFIER]
```
-A file with code
-
## Exports
### \`export
@@ -45,4 +43,4 @@ namespcae[name] // resolves to namespace[name.name]
### \`is_main
-Run this function if the file is not imported
+Run this function if the module is not imported
diff --git a/docs/type_system/shared.md b/docs/type_system/shared.md
index db8e6dc..2af408d 100644
--- a/docs/type_system/shared.md
+++ b/docs/type_system/shared.md
@@ -5,13 +5,9 @@
Hold multiple references to the same object
```text
-Shared[[LOCK] Type]
+Shared[[] Type]
```
-### `LOCK`
-
-The shared type has been detected across asynchronous tasks and needs to lock the mutex on mutation
-
# Garbage Collection
A tracing mark and sweep garbage collector is used
diff --git a/docs/type_system/value.md b/docs/type_system/value.md
index 683b1f2..5cfcf90 100644
--- a/docs/type_system/value.md
+++ b/docs/type_system/value.md
@@ -3,5 +3,5 @@
---
```text
-Value[[] TYPE; DATA]
+Value[[] TYPE; KPL_CLASS]
```