Update doc comments to reflect current behavior

master
J.C. Moyer 2020-10-30 23:31:03 -04:00
parent bb6e39e274
commit b38dea37c7
1 changed files with 3 additions and 1 deletions

View File

@ -64,7 +64,9 @@ fn peekIsAlign(comptime fmt: []const u8) bool {
/// - `x` and `X`:
/// - format the non-numeric value as a string of bytes in hexadecimal notation ("binary dump") in either lower case or upper case
/// - output numeric value in hexadecimal notation
/// - `s`: print a pointer-to-many as a c-string, use zero-termination
/// - `s`:
/// - for pointer-to-many and C pointers of u8, print as a C-string using zero-termination
/// - for slices of u8, print the entire slice as a string without zero-termination
/// - `z`: escape the string with @"" syntax if it is not a valid Zig identifier.
/// - `Z`: print the string escaping non-printable characters using Zig escape sequences.
/// - `B` and `Bi`: output a memory size in either metric (1000) or power-of-two (1024) based notation. works for both float and integer values.