Skip to content

Commit 8bec2fb

Browse files
authored
chore: make some documents clearer (#528)
1 parent e0b1d91 commit 8bec2fb

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

c/blake3.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ extern "C" {
3838
#define BLAKE3_MAX_DEPTH 54
3939

4040
// This struct is a private implementation detail. It has to be here because
41-
// it's part of blake3_hasher below.
41+
// it's part of the blake3_hasher structure defined below.
4242
typedef struct {
4343
uint32_t cv[8];
4444
uint64_t chunk_counter;

src/hazmat.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,9 +335,9 @@ fn test_max_subtree_len() {
335335
/// than `input_len`. This leads to a tree where all left subtrees are "complete" and at least as
336336
/// large as their sibling right subtrees, as specified in section 2.1 of [the BLAKE3
337337
/// paper](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf). For example, if an
338-
/// input is exactly two chunks, its left and right subtrees both get one chunk. But if an input is
339-
/// two chunks plus one more byte, then its left subtree gets two chunks, and its right subtree
340-
/// only gets one byte.
338+
/// input is exactly two chunks, the left subtree gets the first chunk and the right subtree gets
339+
/// the second chunk. But if an input is two chunks plus one more byte, then its left subtree gets
340+
/// two chunks, and its right subtree only gets one byte.
341341
///
342342
/// This function isn't meaningful for one chunk of input, because chunks don't have children. It
343343
/// currently panics in debug mode if `input_len <= CHUNK_LEN`.

src/test.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -982,7 +982,7 @@ fn test_serde() {
982982
// Version 1.5.2 of this crate changed the default serialization format to a bytestring
983983
// (instead of an array/list) to save bytes on the wire. That was a backwards compatibility
984984
// mistake for non-self-describing formats, and it's been reverted. Since some small number of
985-
// serialized bytestrings will probably exist forever in the wild, we shold test that we can
985+
// serialized bytestrings will probably exist forever in the wild, we should test that we can
986986
// still deserialize these from self-describing formats.
987987
let bytestring_cbor: &[u8] = &[
988988
0x58, 0x20, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe,

0 commit comments

Comments
 (0)