zig

commit d06bfc2e2a5e873d3d7e28cf78a46b8454c633aa (tree)
parent ab4ea5d3cf5a96cd596df14515521843ca4dccad
Author: vegecode <justin.b.alexander1@gmail.com>
Date:   Wed, 12 Feb 2020 13:16:32 -0600

Correct comment to include comptime attribute on format output fn parameter

Without comptime, printing custom type through the stream interface fails

Diffstat:
M
lib/std/fmt.zig
 | 
2
+-

1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lib/std/fmt.zig b/lib/std/fmt.zig
@@ -69,7 +69,7 @@ fn peekIsAlign(comptime fmt: []const u8) bool {
 ///
 /// If a formatted user type contains a function of the type
 /// ```
-/// fn format(value: ?, comptime fmt: []const u8, options: std.fmt.FormatOptions, context: var, comptime Errors: type, output: fn (@TypeOf(context), []const u8) Errors!void) Errors!void
+/// fn format(value: ?, comptime fmt: []const u8, options: std.fmt.FormatOptions, context: var, comptime Errors: type, comptime output: fn (@TypeOf(context), []const u8) Errors!void) Errors!void
 /// ```
 /// with `?` being the type formatted, this function will be called instead of the default implementation.
 /// This allows user types to be formatted in a logical manner instead of dumping all fields of the type.