Improve description of string allocation functions #2903
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
beutlich
reviewed
Mar 22, 2021
Applying suggestion by Thomas. Co-authored-by: Thomas Beutlich <modelica@tbeu.de>
Remove 'all' Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
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.
Fixes #2858.
Now that it is clear that these functions are not only for strings that will be returned from the external function, it made sense to break out the part that is specifically about
Stringoutputs.I had to struggle a bit to find a sensible reason why one must not return memory allocated with, say,
malloc. It almost seemed silly to not simply make it the responsibility of the external code to somehow take care of cleanup of such strings (typically through the deallocator of an external object, I imagined). Please pay special attention to this new formulation!