document ~ at start of token expanding into ${HOME}

rain-1 · Jun 27, 2017 · 10e7b22 · 10e7b22
1 parent fde0e62
commit 10e7b22
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/tokens.txt b/docs/tokens.txt
@@ -15,6 +15,8 @@ You can use \ at the end of a line to ignore the EOL (for making a single comman
 WORD ::= WORDCH +
        | `~` WORDH +
 
+note: ~ at the start of a token gets expanded into ${HOME}.
+
 WORDCH ::= '\' <any char>
          | <any char except '\\' ' ' '\t' '\n' '#'>