Add documentation for the cold and track_caller attributes#158484
Open
valentynkit wants to merge 1 commit into
Open
Add documentation for the cold and track_caller attributes#158484valentynkit wants to merge 1 commit into
cold and track_caller attributes#158484valentynkit wants to merge 1 commit into
Conversation
Document the built-in `cold` and `track_caller` attributes in the standard library using the `#[doc(attribute = "...")]` mechanism, following the existing `must_use` and `inline` attribute documentation.
rustbot
added
S-waiting-on-review
80 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Adds
coldandtrack_caller, the two code generation attributes left from my claim on the tracking issue.Both stay guide-level, with one runnable example each. For
track_callerI used a small assert-style helper, since the attribute mainly affects which line a panic points at.inlineis already up in #158348.Part of #157604
r? @GuillaumeGomez
Tested with
./x test library/std --doc --test-args attribute_docs.