Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation bug in FmtContext::visit_spans #2940

Open
Xaeroxe opened this issue Apr 19, 2024 · 0 comments
Open

Documentation bug in FmtContext::visit_spans #2940

Xaeroxe opened this issue Apr 19, 2024 · 0 comments

Comments

@Xaeroxe
Copy link

Xaeroxe commented Apr 19, 2024

Bug Report

Version

tracing-subscriber 0.3.18

Platform

Documentation

Crates

tracing-subscriber

Description

The documentation for FmtContext::visit_spans claims that it will call the closure on the current span, and then upwards to the root span. The actual behavior is the reverse of this. It starts at the root, and then descends to the current span.

Either the implementation or the documentation should be updated. My preference is the documentation should be updated.
kaffarell added a commit to kaffarell/tracing that referenced this issue Apr 22, 2024
@kaffarell
docs: fix function comment
a01924e 
The comment on the `visit_spans` fn is wrong. Change it to the correct
order.

Fixes: tokio-rs#2940
@kaffarell kaffarell mentioned this issue Apr 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Xaeroxe