Mention pitfall in ObjectTracerContext::with_tracer doc comment
#1259
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
wks
reviewed
Jan 13, 2025
Comment on lines
+64
to
+68
| /// A typical use-case of this method is to call `ObjectTracer::trace_object` in a loop for | ||
| /// finalization candidates to create `ProcessEdgesWork` packets. | ||
| //// **Note**: Do not use this API in such a way that only one object is enqueued at a time. | ||
| /// This can result in creating a work packet for a single object, exhausting (physical) memory | ||
| /// if there are enough finalization candidates. |
There was a problem hiding this comment.
I think the description is too specific to the bug you fixed recently. It's not specific to finalization (it's also applicable to SoftReference), and it is better to provide an example of the right way to use it, and then describe the consequence of flipping the order of the loop and the closure. You can leave this to me. I plan to write a dedicated porting guide section for weak references and finalizers, and update this doc comment at the same time.
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.
No description provided.