Description
PR #6461 (closing #6449) added crates/zeph-common/src/anchor.rs
(Anchor, AnchorStore trait, AnchorSubsystem, anchor_key/
parse_anchor_key). All public items have doc comments, but none include
a # Examples doctest section, unlike the sibling hash_chain.rs module
which has one. Per CLAUDE.md's rustdoc rules, non-trivial public APIs
should include a runnable example.
Low priority: the current public items are simple constructors and
key-codec functions, so the gap is a letter-of-the-rule item rather than
a real documentation-usability gap.
Expected Behavior
At least one # Examples doctest on a representative public item in
crates/zeph-common/src/anchor.rs (e.g. anchor_key/parse_anchor_key
round-trip, or constructing an Anchor), matching the pattern already
used in hash_chain.rs.
Actual Behavior
No doctest examples currently present in the module.
Environment
Description
PR #6461 (closing #6449) added
crates/zeph-common/src/anchor.rs(
Anchor,AnchorStoretrait,AnchorSubsystem,anchor_key/parse_anchor_key). All public items have doc comments, but none includea
# Examplesdoctest section, unlike the siblinghash_chain.rsmodulewhich has one. Per CLAUDE.md's rustdoc rules, non-trivial public APIs
should include a runnable example.
Low priority: the current public items are simple constructors and
key-codec functions, so the gap is a letter-of-the-rule item rather than
a real documentation-usability gap.
Expected Behavior
At least one
# Examplesdoctest on a representative public item incrates/zeph-common/src/anchor.rs(e.g.anchor_key/parse_anchor_keyround-trip, or constructing an
Anchor), matching the pattern alreadyused in
hash_chain.rs.Actual Behavior
No doctest examples currently present in the module.
Environment
crates/zeph-common/src/anchor.rs