Improve Local SystemParam text, examples #21718
Merged
+65
−15
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
isHavvy
force-pushed
the
local_param_doc
branch
from
ffab449 to
d4b95e7
Compare
alice-i-cecile
added
C-Docs
alice-i-cecile
requested changes
Nov 3, 2025
Member
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
A few suggestions, but I like the direction of this :)
Contributor
Author
|
Review comments addressed. Also saw a comment in one example that was meant to be deleted after a copy/paste. Also added another example about using locals to save on reallocations. Do need an opinion on whether it's a good example or not. |
alice-i-cecile
approved these changes
Nov 4, 2025
Member
I really like this: it's a common and useful pattern. |
alice-i-cecile
added
X-Uncontroversial
Zeophlite
added
S-Ready-For-Final-Review
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.
Objective
Explain
Local<T>better to newbies.Solution
Add more examples of how to use
Local<T>and document howTis initialized for this type.I tried to order the examples from basic information to more niche information.
I have no clue if the configuration example is useful or even what it's trying to convey. The blame log shows that there was some configuration thing that was removed.
Furthermore, I added a doc comment to the SystemParam impl giving a very short description of what it provides as a system parameter. I think all non-tuple impls should provide such a blurb so that looking at the implementations for the trait itself provides useful information besides just the name. If that is wanted, an issue should be opened for it. If it is not, either I or the reviewer who commits this can remove the line.
Testing
I ran the doctests. I also built the docs and checked that the links work.