Added explanatory comments in runtime.rs for better understanding for… #6747
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.
Added explanatory comments for RuntimeMetrics methods
Motivation
The current documentation for
RuntimeMetrics
methods doesn't clearly indicate when bothtokio_unstable
and 64-bit atomic features are required. This can lead to confusion for users trying to use these metrics, especially when compiling for different targets or with different feature sets.Solution
As a temporary measure, I've added inline comments to the
RuntimeMetrics
implementation inruntime.rs
. These comments explicitly state when a method requires both thetokio_unstable
feature and 64-bit atomics.This is intended as an intermediate step towards a more comprehensive solution that may involve modifying the
cfg
macros to properly combine these conditions in the documentation.Changes made:
RuntimeMetrics
implementation inruntime.rs
tokio_unstable
and 64-bit atomics are requiredFixes Some unstable runtime metrics show up as stable in docs.rs #6745