Improve documentation for file dialogs #5171
Merged
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.
Description:
When using file dialogs it is currently unclear from the documentation whether the reader/writer passed in the callbacks need to be closed. This may lead to obscure bugs, since the file is often still read/created. I therefore like to propose extending the comments to clarify that those in fact must be closed by the callback.
I further like to propose adding variable names in the callbacks to make it clearer to the user what they are (e.g. those will be added to the users code though auto-complete).
See also related conversation with Andy on Discord.
Checklist:
Where applicable:
N/A