Minor: Document memory management design on MemoryPool
#8966
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
github-actions
bot
removed
the
documentation
8 tasks
tustvold
approved these changes
Jan 23, 2024
comphead
reviewed
Jan 23, 2024
| /// [`MemoryPool`] before allocating more. The request is typically managed via | ||
| /// a [`MemoryReservation`]. | ||
| /// | ||
| /// If the allocation is successful, the operator should proceed and allocate |
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.
Which issue does this PR close?
Related to #587
Rationale for this change
@SteveLauC asked about this on #587 (comment)
and I realized the rationale and high level design of the memory management system wasn't documented anywhere
What changes are included in this PR?
Add doc comments to
MemoryPoolto add more background and rationaleAre these changes tested?
Covered by existing doc comments
Are there any user-facing changes?
Better docs