Skip to content

Commit 0f6a6a9

Browse files
committed
correct document misref
1 parent 8dd63ae commit 0f6a6a9

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

src/root.zig

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
//! ^ ~~~~~~ The string content
2323
//! ```
2424
//!
25-
//! So to put a string into the document, use the `prefixString` to write the
26-
//! prefix, and write the content.
25+
//! So to put a string into the document, use the functions from `AnyStr` to
26+
//! write the prefix, and write the content.
2727
//!
2828
//! ```zig
2929
//! const content = "Hello World";
@@ -343,17 +343,6 @@ pub const Bool = struct {
343343
};
344344

345345
/// Use this constant to decide the `Prefix` buffer size in comptime.
346-
///
347-
/// The prefixs are not always filled up all the buffer.
348-
///
349-
/// ```zig
350-
/// var buf: [zigpak.PREFIX_BUFSIZE]u8 = undefined;
351-
///
352-
/// const prefix = prefixString(12);
353-
/// std.mem.copyForward(u8, &buf, prefix.constSlice());
354-
///
355-
/// const header = buf[0..prefix.len]; // the actual header
356-
/// ```
357346
pub const PREFIX_BUFSIZE = 6;
358347

359348
/// The prefix for a value.

0 commit comments

Comments
 (0)