Reuh/anselme
1
0
Fork 0
mirror of https://github.com/Reuh/anselme.git synced 2025-10-27 16:49:31 +00:00
Code Releases Activity

[doc] update gendocs for Anselme standard library and add title and defer tags

Browse source
This commit is contained in:
Étienne Fildadut 2024-05-28 18:14:10 +02:00
parent a631334b31
commit bdc4f8a13a
5 changed files with 162 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

51
doc/standard_library.md
View file

@ -1,13 +1,52 @@
TODO generate from source
TODO
# Standard library
# Variable assignment
TODO intro
#### identifier = value
Assign `value` to the variable `identifier`.
_defined at line 50 of [anselme/stdlib/assignment.lua](../anselme/stdlib/assignment.lua):_ `"_=_", "(quote::is quoted(\"identifier\"), value)",`
#### symbol::is symbol = value
Define the variable using the symbol `symbol` with the initial value `value`.
_defined at line 59 of [anselme/stdlib/assignment.lua](../anselme/stdlib/assignment.lua):_ `"_=_", "(quote::is quoted(\"symbol\"), value)",`
#### variable tuple::is tuple = value tuple::is tuple
For each `variable` element of the variable tuple and associated `value` element of the value tuple, call `variable = value`.
_defined at line 73 of [anselme/stdlib/assignment.lua](../anselme/stdlib/assignment.lua):_ `"_=_", "(quote::is quoted(\"tuple\"), value::is tuple)",`
# Value checking
TODO
## Variable assignment
#### constant (exp)
Always return false.
Can be used as variable value checking function to prevent any reassignment and thus make the variable constant.
```
:var::constant = 42
```
_defined at line 12 of [anselme/stdlib/assignment.lua](../anselme/stdlib/assignment.lua):_ `"constant", "(exp)",`
#### is tuple (exp)
Returns true if the expression is a tuple, false otherwise.
_defined at line 21 of [anselme/stdlib/assignment.lua](../anselme/stdlib/assignment.lua):_ `"is tuple", "(exp)",`
# Control flow
TODO
## Control flow
TODO
---
_file generated at 2024-05-28T16:12:56Z_