Added documentation for common mistakes in errdefer scoping #10607
Conversation
This file contains hidden or 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
Vexu
approved these changes
Feb 13, 2022
|
Reverted in 3ce6de8. This kind of thing does not belong in the language reference. |
|
#7298 should probably be reopened then. |
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.
This PR adds a subsection to the Error Union Type section of the documentation to inform readers about common mistakes caused by errdefer scoping (e.g. allocated memory leaving the scope of an errdefer and being leaked) to hopefully save some people from shooting themselves in the foot. In commit e9c7987, I added a header to separate this from the errdefer subsection because I felt it was distinct enough, but it's completely optional imo
This PR is intended to resolve issue #7298