Skip to content

streebog: fix stale doc comments in consts - #933

Merged
newpavlov merged 1 commit into
RustCrypto:masterfrom
elonfliter:streebog-consts-docs
Oct 19, 2026
Merged

newpavlov merged 1 commit into
RustCrypto:masterfrom
elonfliter:streebog-consts-docs

Conversation

@elonfliter

Copy link
Copy Markdown
Contributor

Two comments in streebog/src/consts.rs no longer match the code:

  • The module docs refer to table::SHUFFLED_LIN_TABLE, but there is no
    table module in the crate. SHUFFLED_LIN_TABLE is generated in this
    module, so the path is dropped.
  • C64 is documented as [u64; 8], which was true until streebog: tweak internal implementation #925 replaced
    the [[u64; 8]; 12] type with [U512; 12]. The comment now claims a
    single 8-word constant where there are 12 iteration constants.

Comment-only change; no functional difference. cargo test -p streebog
passes (7 tests + 1 doctest).

`C64` stopped being `[[u64; 8]; 12]` in RustCrypto#925, when the internal `U512`
type was introduced, but its doc comment still claims the iteration
constants are represented as `[u64; 8]`.

The module docs also point at `table::SHUFFLED_LIN_TABLE`, although the
crate has no `table` module: the table is generated in this very module.
@newpavlov
newpavlov merged commit 31da55d into RustCrypto:master Oct 19, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants