document how to escape curly braces in fmt.format

2020-09-04 21:11:09 +02:00
parent 6b2f4fd20d
commit 0c43b6ef5c
1 changed files with 2 additions and 0 deletions
--- a/lib/std/fmt.zig
+++ b/lib/std/fmt.zig
@@ -82,6 +82,8 @@ fn peekIsAlign(comptime fmt: []const u8) bool {
 /// This allows user types to be formatted in a logical manner instead of dumping all fields of the type.
 ///
 /// A user type may be a `struct`, `vector`, `union` or `enum` type.
+///
+/// To print literal curly braces, escape them by writing them twice, e.g. `{{` or `}}`.
 pub fn format(
    writer: anytype,
    comptime fmt: []const u8,