Skip to content

Commit bf56345

Browse files
msg: comments typos
Signed-off-by: Francis Bouvier <[email protected]>
1 parent 2bc58be commit bf56345

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

src/msg.zig

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ const std = @import("std");
2020

2121
// pub const MaxStdOutSize = 512; // ensure debug msg are not too long
2222

23-
/// MsgBuffer return messages from a raw text read stream,
23+
/// MsgBuffer returns messages from a raw text read stream,
2424
/// according to the following format `<msg_size>:<msg>`.
2525
/// It handles both:
2626
/// - combined messages in one read
27-
/// - single message in several read (multipart)
28-
/// It is safe (and good practice) to reuse the same MsgBuffer
27+
/// - single message in several reads (multipart)
28+
/// It's safe (and a good practice) to reuse the same MsgBuffer
2929
/// on several reads of the same stream.
3030
pub const MsgBuffer = struct {
3131
size: usize = 0,
@@ -56,8 +56,7 @@ pub const MsgBuffer = struct {
5656

5757
// read input
5858
// - `do_func` is a callback to execute on each message of the input
59-
// - `data` is a arbitrary payload that will be passed to the callback along with
60-
// the message itself
59+
// - `data` is an arbitrary user data that will be forwarded to the do_func callback
6160
pub fn read(
6261
self: *MsgBuffer,
6362
alloc: std.mem.Allocator,

0 commit comments

Comments
 (0)