aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHugues Evrard <hevrard@users.noreply.github.com>2019-03-15 16:19:32 +0100
committerGitHub <noreply@github.com>2019-03-15 16:19:32 +0100
commite822b18aacc7680dc0454c9614ae3d6348fd5125 (patch)
tree513b3bb2f9070d7bcd435c757cf3aab64f990740 /docs
parent3e6826cf4e3a5eaaacc20e63a014fecadcc92bda (diff)
downloadamber-e822b18aacc7680dc0454c9614ae3d6348fd5125.tar.gz
Clarify AmberScript comment definition (#370)
Diffstat (limited to 'docs')
-rw-r--r--docs/amber_script.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/amber_script.md b/docs/amber_script.md
index 454cfe7..60869a8 100644
--- a/docs/amber_script.md
+++ b/docs/amber_script.md
@@ -6,9 +6,10 @@ is based on the Talvos format, VkRunner format, and VkScript proposed format.
## Specification
All amber scripts must start with `#!amber` as the first line. Comments are
-specified by a # character and continue to the end of the line. Keywords are
-case sensitive. All names are made up of ASCII characters, and delimited by
-whitespace.
+specified by a # character and continue to the end of the line, except in
+inlined shader source code, where AmberScript comments are not
+possible. Keywords are case sensitive. All names are made up of ASCII
+characters, and delimited by whitespace.
TODO(dneto): What characters are valid in a name?