docs: fix function comment #2947
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The comment on the `visit_spans` fn is wrong. Change it to the correct order. Fixes: tokio-rs#2940
mladedav
suggested changes
Apr 22, 2024
| /// and then with that span's parent, and then that span's parent, | ||
| /// and so on until a root span is reached. | ||
| /// The provided closure will be called first with the root span, | ||
| /// and then traverse through all the children until it reaches |
There was a problem hiding this comment.
I think that "all the children" is potentially misleading as one could take that to mean the children of the root span.
I can't really think of how to make the wording clearer, for reference this is how SpanRef::scope documents this so maybe use something similar (but reverse and with callback)?
/// Returns an iterator over all parents of this span, starting with this span,
/// ordered from leaf to root.
There was a problem hiding this comment.
I agree, how about I just remove the 'all'?
So: '...traverse through the children until it ...'.
I could also write:
Calls the callback function for all the parents of the span, starting with the root span, ordered from root to current.
but IMO this is more confusing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The comment on the
visit_spansfn is wrong. Change it to the correct order.Fixes: #2940