span: improve docs for Span getters #52
Merged
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
I noticed that at least [one person] was confused about what it should return. In particular, the getters on a `Span` return the individual units, and not the "total" amount of them in the entire span. This is different from how "absolute" durations work that don't keep track of the individual units in the span. [one person]: https://lobste.rs/s/rnqlef/named_arguments_rust_if_you_want_them#c_iiap4n
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
I noticed that at least one person was confused about what it should
return. In particular, the getters on a
Spanreturn the individualunits, and not the "total" amount of them in the entire span. This is
different from how "absolute" durations work that don't keep track of
the individual units in the span.