ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

templates.md docs: Document string literal format

Browse source 
We are a little weird about which string escapes we support, and we don't
support raw strings.  I thought this might be worth documenting.

Inspired by https://github.com/martinvonz/jj/pull/2251
This commit is contained in:
Ilya Grigoriev 2023-09-14 16:43:47 -07:00
parent c5f74bc466
commit c45216ed02
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/templates.md
View file

@ -148,6 +148,14 @@ defined.
* `.remove_suffix(needle: Template) -> String`: Removes the passed suffix, if present * `.remove_suffix(needle: Template) -> String`: Removes the passed suffix, if present
* `.substr(start: Integer, end: Integer) -> String`: Extract substring. Negative values count from the end. * `.substr(start: Integer, end: Integer) -> String`: Extract substring. Negative values count from the end.
#### String literals
String literals must be surrounded by double quotes (`"`). The following escape
sequences starting with a backslash have their usual meaning: `\"`, `\\`, `\n`,
`\r`, `\t`, `\0`. Other escape sequences are not supported. Any UTF-8 characters
are allowed inside a string literal, with two exceptions: unescaped `"`-s and
uses of `\` that don't form a valid escape sequence.
### Template type ### Template type
Most types can be implicitly converted to `Template`. No methods are defined. Most types can be implicitly converted to `Template`. No methods are defined.