High-performance, multi-platform, type-safe programming language designed for visual & AI assisted development
BSD 3-Clause "New" or "Revised" License
68
stars
14
forks
source link
Document all missing and pending Shards functions #323
Open
satendrapalsingh opened 2 years ago
Document missing and/or pending Shards functions.
Format, function and data-structure references:
As part of the documentation, add/update/fix:
107 functions
Add new category: .../functions/predicates:
Var?
: BUILTIN("Var?"), SHCore.cpp - missing, add (description, code-sample)Mesh?
: BUILTIN("Mesh?"), SHCore.cpp - missing, add (description, code-sample), add primer-link (!!! note, What's amesh
?)Shard?
: BUILTIN("Shard?"), SHCore.cpp - missing, add (description, code-sample), add primer-link (!!! note, What's ashard
?)Wire?
: BUILTIN("Wire?"), SHCore.cpp - missing, add (description, code-sample), add primer-link (!!! note, What's awire
?)atom?
: BUILTIN_ISA("atom?", malAtom), Core.cpp - missing, add (description, code-sample)keyword?
: BUILTIN_ISA("keyword?", malKeyword), Core.cpp - missing, add (description, code-sample)list?
: BUILTIN_ISA("list?", malList), Core.cpp - missing, add (description, code-sample)map?
: BUILTIN_ISA("map?", malHash), Core.cpp - missing, add (description, code-sample)hash-map?
: BUILTIN("hash-map"), Core.cpp - missing, add (description, code-sample)number?
: BUILTIN_ISA("number?", malNumber), Core.cpp - missing, add (description, code-sample)sequential?
: BUILTIN_ISA("sequential?", malSequence), Core.cpp - missing, add (description, code-sample)string?
: BUILTIN_ISA("string?", malString), Core.cpp - missing, add (description, code-sample)symbol?
: BUILTIN_ISA("symbol?", malSymbol), Core.cpp - missing, add (description, code-sample)vector?
: BUILTIN_ISA("vector?", malVector), Core.cpp - missing, add (description, code-sample)true?
: BUILTIN_IS("true?", trueValue), Core.cpp - missing, add (description, code-sample)false?
: BUILTIN_IS("false?", falseValue), Core.cpp - missing, add (description, code-sample)nil?
: BUILTIN_IS("nil?", nilValue), Core.cpp - missing, add (description, code-sample)Pending .../functions/collections , rename to
...functions/collection-transformations
?:assoc
- add descriptionconcat
- add (description, code-sample)conj
- add (description, code-samples)cons
- verify/enhance (description, code-samples)contains?
- verify/enhance (description, code-samples)count
- verify/enhance (description, code-samples)dissoc
- add (description, code-samples)empty?
- verify/enhance (description, code-samples)get
- verify/enhance (description, code-samples)first
- add (description, code-samples)keys
- verify/enhance (description, code-samples)nth
- add (description, code-samples)rest
- add (description, code-samples)reverse
- verify/enhance (description, code-samples)vals
- verify/enhance (description, code-samples)eval
: BUILTIN("eval"), Core.cpp - add (description, code-samples)remove
: BUILTIN("remove"), Core.cpp - add (description, code-samples)Pending .../functions/macros:
def!
- add (description, code-samples)defmacro!
- add (description, code-samples)Pending .../functions/operators , rename to
...functions/numeric-operators
?:=
- add(prn)
to code-sample (to print output)<
- add(prn)
to code-sample (to print output)>
- add(prn)
to code-sample (to print output)<=
- add(prn)
to code-sample (to print output)>=
- add(prn)
to code-sample (to print output)Pending .../functions/standard-output:
println
- mention (string values are printed without quotes)prn
- mention (string values are printed with quotes)read-var
: BUILTIN("read-var"), SHCore.cpp - missing, add (description, code-sample)set-var
: BUILTIN("set-var"), SHCore.cpp - missing, add (description, code-sample)LOG
: BUILTIN("LOG"), SHCore.cpp - missing, add (description, code-sample)Pending .../functions/strings:
pr-str
- mention (all values are printed with quotes), validate code-sampleslurp
- verify/enhance (description, code-samples)str
- validate code-samplePending .../functions/values:
list
- add (description, code-samples)hash-map
- add (description, code-samples)map
- add (description, code-samples)seq
- add (description, code-samples)vector
- add (description, code-samples)vec
: BUILTIN("vec"), Core.cpp - add (description, code-samples)nil
: ??? - missing, add (description, code-samples)path
: BUILTIN("path") - missing, add (description, code-sample)enum
: BUILTIN("enum") - missing, add (description, code-sample)Wire
: BUILTIN("Wire") - missing, add (description, code-sample), add primer-link (!!! note, What's awire
?)Pending .../functions/misc:
apply
- add (description, code-samples)atom
- add (description, code-samples)deref
- add (description, code-samples)fn?
- add (description, code-samples)hex
- add (description, code-samples)keyword
- add (description, code-samples)macro?
- add (description, code-samples)meta
- add (description, code-samples)read-string
- add (description, code-samples)readline
- add (description, code-samples)reset!
- add (description, code-samples)swap!
- add (description, code-samples)symbol
- add (description, code-samples)throw
- add (description, code-samples)time-ms
- add (description, code-samples)with-meta
- add (description, code-samples)Missing .../functions/misc : Confirm these implemented-but-not-documented functions from
Core.cpp
-
: BUILTIN("-"), ??? - missing, add (description, code-sample)%
: BUILTIN("%"), Modulus operator - missing, add (description, code-sample)Missing .../functions/misc : Confirm these implemented-but-not-documented functions from
SHCore.cpp
.
: BUILTIN(".") - missing, add (description, code-sample)Mesh
: BUILTIN("Mesh") - missing, add (description, code-sample), add primer-link (!!! note, What's amesh
?)Wire@
: BUILTIN("Wire@") - missing, add (description, code-sample), add primer-link (!!! note, What's awire
?)Wire*
: BUILTIN("Wire*") - missing, add (description, code-sample), add primer-link (!!! note, What's awire
?)->
: BUILTIN("->") - missing, add (description, code-sample)eval-wire
: BUILTIN("eval-wire") - missing, add (description, code-sample), add primer-link (!!! note, What's awire
?)wireify
: BUILTIN("wireify") - missing, add (description, code-sample), add primer-link (!!! note, What's awire
?)unquote
: BUILTIN("unquote") - missing, add (description, code-sample)set-global-wire
: BUILTIN("set-global-wire") - missing, add (description, code-sample)unset-global-wire
: BUILTIN("unset-global-wire"), SHCore.cpp - missing, add (description, code-sample)run-empty-forever
: BUILTIN("run-empty-forever"), SHCore.cpp - missing, add (description, code-sample)prepare
: BUILTIN("prepare"), SHCore.cpp - missing, add (description, code-sample)start
: BUILTIN("start"), SHCore.cpp - missing, add (description, code-sample)tick
: BUILTIN("start"), SHCore.cpp - missing, add (description, code-sample)stop
: BUILTIN("stop"), SHCore.cpp - missing, add (description, code-sample)sleep
: BUILTIN("sleep"), SHCore.cpp - missing, add (description, code-sample)override-root-path
: BUILTIN("override-root-path") - missing, add (description, code-sample)import
: BUILTIN("import") - missing, add (description, code-sample)getenv
: BUILTIN("getenv") - missing, add (description, code-sample)setenv
: BUILTIN("setenv") - missing, add (description, code-sample)settings-try-set-min
: BUILTIN("settings-try-set-min") - missing, add (description, code-sample)settings-try-set-max
: BUILTIN("settings-try-set-max) - missing, add (description, code-sample)hasShard?
: BUILTIN("hasShard?") - missing, add (description, code-sample), add primer-link (!!! note, What's ashard
?)shards
: BUILTIN("shards") - missing, add (description, code-sample), add primer-link (!!! note, What's ashard
?)info
: BUILTIN("'info") - missing, add (description, code-sample)export-strings
: BUILTIN("export-strings") - missing, add (description, code-sample)decompress-strings
: BUILTIN("decompress-strings") - missing, add (description, code-sample)Missing .../functions/misc : Confirm these implemented-but-not-documented functions (source code unknown)
load-file
: ??? - missing, add (description, code-sample)quote
: ??? - missing, add (description, code-sample)quasiquote
: ??? - missing, add (description, code-sample)