docs(storage-node): fix stale comments (doc drift)#442
Open
dsmfa10 wants to merge 1 commit into
Open
Conversation
Comment-only corrections, no behavior change: - registry/core.rs: `X-DSM-DLV-ID` is Base32 Crockford, not "hex-encoded" (decoded via `parse_optional_dlv_id`; the crate bans hex). - main.rs: module doc asserted "Parameters: N=6, K=3, U_up=0.85, U_down=0.35" which appear nowhere in code; capacity/scaling params are runtime config. Reword to say so. - timing.rs: drop the stale "(replaces bitwise shift logic)" historical note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem & fix (3 comment corrections)
src/api/registry/core.rs— comment said// - X-DSM-DLV-ID: hex-encoded DLV id, but the value is decoded viaparse_optional_dlv_idas Base32 Crockford (the crate bans hex). Rewordedto "Base32 Crockford DLV id (no hex; decoded by parse_optional_dlv_id)".
src/main.rs— module doc assertedParameters: N=6, K=3, U_up=0.85, U_down=0.35. These values appear nowhere inthe code; capacity/scaling parameters are runtime config (
[replication]/ReplicationConfig). Reworded to say so rather than assert hardcoded numbers.src/timing.rs— dropped the stale historical note/// Calculate exponential backoff delay (replaces bitwise shift logic)→/// Calculate exponential backoff delay.Verification
cargo checkclean (comments only).CI gates & coverage
Full verification for this PR runs in CI — Rust (
cargo fmt --check,clippy -D warnings, workspace tests), Frontend, Android Unit Tests,Coverage, SPDX headers, CodeQL (see the PR's Checks tab). The local
check noted above is a subset; the broader mandated gates (full workspace test
suite, codegen/scan, Android, Frontend) run in CI, not locally — none is
silently skipped.