diff options
| author | Drahflow <drahflow@gmx.de> | 2014-03-31 00:24:05 +0200 |
|---|---|---|
| committer | Drahflow <drahflow@gmx.de> | 2014-03-31 00:24:05 +0200 |
| commit | c61d0d4fe1079dfe5e1b40e0f301d6d1c77a136d (patch) | |
| tree | 0593f2091ec513b863728088db66a10859f73735 /doc/conventions.md | |
| parent | 2387a3eafbd13c0b27797ac1434e45bb36d632c2 (diff) | |
Some documentation (and resulting code-cleanup)
Diffstat (limited to 'doc/conventions.md')
| -rw-r--r-- | doc/conventions.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/conventions.md b/doc/conventions.md new file mode 100644 index 0000000..1cb1425 --- /dev/null +++ b/doc/conventions.md @@ -0,0 +1,38 @@ +Conventions +=========== + +Global function names try to follow a certain schema. The initial character (and sometimes later ones as well) +roughly connect to various topics as follows: + +`!`: Co-routines +`"`: Strings +`#`: Scope based complex data types; comments +`$`: - +`%`: - +`&`: - +`'`: Types +`(`: - +`)`: - +`*`: Function execution +`+`: - +`,`: - +`-`: Stack manipulation +`.`: Field dereference +`/`: Keyword-like strings +`:`: - +`;`: Function composition +`<`: Scope start +`=`: Assignment +`>`: Scope end +`?`: Ternary operator; error handling +`@`: - +`[`: Array begin +`\`: Executing dereference +`]`: Array end +`^`: - +`_`: Stack manipulation +`` ` ``: - +`{`: Code begin +`|`: Nonexecuting dereference +`}`: Code end +`~`: - |