Skip to content

Commit d5e3327

Browse files
committed
fix(bench): stop public docs linking to crate-private items
`cargo doc` denies `rustdoc::private_intra_doc_links`, so the module doc and two public methods failed to document while pointing at `measured_note_key` and `UNKNOWN_NOTE_LABEL`. Both stay crate-private, so drop the links and name them in plain code spans. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LXcU9HrrmWTCTZTJZnuLSU
1 parent 3cb9415 commit d5e3327

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

bin/bench-transaction/src/note_labels.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//! among the same-kind notes changes.
88
//!
99
//! Labels are keyed by the note's details commitment, which is what a measurement entry carries
10-
//! today; see [`measured_note_key`].
10+
//! today; see `measured_note_key`.
1111
1212
use std::collections::{BTreeMap, BTreeSet};
1313

@@ -38,7 +38,7 @@ impl NoteLabels {
3838
///
3939
/// # Errors
4040
/// Returns an error if two input notes share a details commitment, which would make the join
41-
/// in [`NoteLabels::label`] ambiguous. See [`measured_note_key`].
41+
/// in [`NoteLabels::label`] ambiguous. See `measured_note_key`.
4242
pub fn from_inputs(inputs: &TransactionInputs) -> Result<Self> {
4343
Self::from_script_roots(inputs.input_notes().iter().map(|input_note| {
4444
(input_note.note().details_commitment(), input_note.note().script().root())
@@ -48,7 +48,7 @@ impl NoteLabels {
4848
/// Returns the label of the given note, or `None` if it is not one of the labelled input
4949
/// notes.
5050
///
51-
/// A miss is distinct from [`UNKNOWN_NOTE_LABEL`], which is itself a legitimate label: callers
51+
/// A miss is distinct from `UNKNOWN_NOTE_LABEL`, which is itself a legitimate label: callers
5252
/// join the kernel-reported measurement key against these labels, and a key that fails to
5353
/// resolve is a defect in that join rather than an unrecognised note kind.
5454
pub fn label(&self, note: NoteDetailsCommitment) -> Option<&str> {

0 commit comments

Comments
 (0)