docs(output): dump_ops Result doc-link points at dead #variant.Result anchor

[dekobon]

Summary

The dump_ops / dump_ops_with_color doc comments declare a
reference-style intra-doc link target [Result]: #variant.Result
that points at a non-existent page anchor, producing a dead link in
the rendered rustdoc.

Location

• src/output/dump_ops.rs:41 (and the body reference at line 14)

The identical pattern is mirrored in the two sibling dumpers:

• src/output/dump_metrics.rs:73 (body ref at line 50)
• src/output/dump.rs:42 (body ref at line 21)

Evidence

/// Returns a [`Result`] value, when an error occurs.
...
/// [`Result`]: #variant.Result
pub fn dump_ops(ops: &Ops) -> std::io::Result<()> {

[Result] is referenced in the body, and the trailing definition
overrides its target to the relative URL #variant.Result. Because
the definition contains a URL fragment, rustdoc treats it as an
explicit-URL link (not an intra-doc link), so cargo doc -D warnings
does not flag it — but the emitted <a href="#variant.Result">
points at an anchor that does not exist on a free function's rustdoc
page (#variant.* anchors only exist on enum pages). Clicking the
rendered Result link goes nowhere.

The intent is clearly to link the standard Result type. With the
type in scope, the bare [Result] reference already resolves to
std::result::Result via intra-doc linking; the #variant.Result
definition line is both unnecessary and actively wrong.

Expected Behavior

The Result link in the rendered docs resolves to a real target
(the std::result::Result page), or the broken explicit-URL
definition is removed so intra-doc resolution handles it.

Actual Behavior

The link points at #variant.Result, a dead in-page anchor.

Impact

Readers of the published big-code-analysis rustdoc (crates.io /
docs.rs) who click the Result link in dump_ops,
dump_ops_with_color, dump_root, dump_root_with_color, or
dump_node land on nothing. Cosmetic but user-facing on the
published API surface.

---

Resolution

Fixed in 7a41184: removed the three dead #variant.Result doc-link lines; intra-doc resolves bare [Result]. cargo doc clean.

[dekobon]

General Plan for Fix

Root Cause

The doc comments carry a leftover reference-style link definition
[Result]: #variant.Result. The #variant.* anchor form only
exists on enum rustdoc pages; on a free function it resolves to
nothing. Because the definition supplies an explicit URL fragment,
rustdoc does not treat it as an intra-doc link and so cargo doc -D warnings stays green while the rendered link is dead.

Implementation Steps

1. In src/output/dump_ops.rs, delete the line
   /// [Result]: #variant.Result. The in-body [`Result`]
   reference then resolves to std::result::Result via standard
   intra-doc linking (the type is in scope through std::io::Result).
2. Apply the same deletion to the two mirrored siblings so the family
   stays consistent: src/output/dump_metrics.rs:73 and
   src/output/dump.rs:42.
3. Optionally, if an explicit target is preferred over implicit
   resolution, replace each definition with
   /// [Result]: std::result::Result instead of deleting it.

Tests to Add/Update

• No unit test covers rendered-doc anchors. Verification is via the
  doc build below; no new test is warranted for a dead-anchor fix.

Verification

• RUSTDOCFLAGS="-D warnings" cargo doc --no-deps -p big-code-analysis clean
• Manual verification: open the generated docs for dump_ops and
  confirm the Result link resolves to the std Result page
  rather than #variant.Result.
• cargo test -p big-code-analysis (doc-tests) still passes

[dekobon]

Fixed in 7a41184. Removed the dead [Result]: #variant.Result doc-link definition lines in dump_ops.rs, dump_metrics.rs, and dump.rs — #variant.* anchors are enum-only and emit broken <a href="#variant.Result"> on a free-function page. Bare [Result] now resolves to std::result::Result via intra-doc linking. Verified with RUSTDOCFLAGS="-D warnings" cargo doc (no warnings).

[dekobon]

Fixed and merged to main in #957. GitHub did not auto-close this from the batched commit's single Fixes #a #b #c … trailer (only the first referenced issue auto-closes); closing manually. See the Resolution section in the body for details.