collection: document garbage collection behaviour of *Map and *Program #579
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
ti-mo
force-pushed
the
tb/document-prog-map-gc
branch
from
b7a41e3 to
41fca98
Compare
Since this behaviour can be surprising, especially when handling prog arrays, document the recommended usage on functions returning Collection/Map/Program. Signed-off-by: Timo Beckers <[email protected]>
ti-mo
force-pushed
the
tb/document-prog-map-gc
branch
from
41fca98 to
f8bac46
Compare
lmb
approved these changes
Feb 23, 2022
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.
Since this behaviour can be surprising, especially in the face of prog arrays, document the recommended usage on functions returning a Collection.
@lmb Should this be echoed in the package doc as well?
#578