Skip to content

output(dump): stale dump_children reference in depth-limit test comment #796

@dekobon

Description

@dekobon

Summary

A test comment in src/output/dump.rs refers to a dump_children
function that no longer exists; the depth - 1 decrement it describes
lives in dump_tree_helper since the #700 recursive-to-iterative
rewrite.

Location

  • src/output/dump.rs:457-462 (test dump_output_depth_limits_recursion)

Evidence

// depth=1 renders the node and stops before its children; depth=0 renders nothing.
// This is the only positive-depth path in production, and it is what the `depth - 1`
// decrement in `dump_children` guards — pin it explicitly.

rg -n "dump_children" src/ matches only this comment — there is no such
function. The depth decrement (let child_depth = depth - 1;) is in
dump_tree_helper (src/output/dump.rs:160). #700 inlined the former
per-children recursion into the single iterative walk, but this comment
kept the old function name.

Expected Behavior

The comment should name dump_tree_helper (or "the iterative walk"),
matching the post-#700 structure.

Actual Behavior

The comment cites a non-existent dump_children, sending a reader
searching for a function that was removed.

Impact

Minor reader-confusion / stale-comment maintenance hazard in test code.


Resolution

Fixed in 7a41184: test comment now names dump_tree_helper's iterative walk instead of the removed dump_children.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions