docs: changed the notes on read_file. #896
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.
This PR alters the notes on
dpp::utility::read_file
. After experimenting in DPP-UE, I realised that there was no note as to what happens if the file is big and causes the event to timeout, causing a crash in DPP-UE and an error log in DPP. I made the note to give more information to users about this, making sure they know to usethinking
if the file is big.The PR also renames the previous note to be a warning. I feel that the warning is very much required so people know that the function can, and will, block the thread, if the file is big.
Documentation change checklist
doxygen
, and testing examples).