Improve documentation of customStrategy #692
Merged
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
(These were not visible in the Haddock output anyway.)
Bodigrim
approved these changes
Sep 19, 2024
clyring
approved these changes
Sep 19, 2024
Bodigrim
pushed a commit
that referenced
this pull request
Oct 9, 2024
* Clarify documentation of 'customStrategy' based on #690 * Remove outdated comments on AllocationStrategy (These were not visible in the Haddock output anyway.)
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.
As requested in #691 (review), this adds a warning to the documentation of
customStrategybased on the discussion in #690 indicating that its ability to reuse buffers is generally unsafe in multithreaded programs.