docs: Update num_alive_tasks docs #7614
Open
+4
−0
Conversation
This file contains hidden or 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
ADD-SP
added
T-docs
ADD-SP
reviewed
Sep 16, 2025
Comment on lines
+57
to
+60
| /// Note: When using the multi-threaded runtime this number may not | ||
| /// not have strong consistency i.e. no tasks may be running but the metric | ||
| /// reports otherwise. | ||
| /// |
There was a problem hiding this comment.
I would say RuntimeMetrics is not designed to be accurate, I think it would better move this "Note" to the struct level.
ADD-SP
added
the
S-waiting-on-author
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.
Motivation
I was confused by this to I opened #7591
Solution
Update the documentation so future people know not to trust this metric when using the multithreaded runtime.