clarify assert doc entry #45998
Merged
clarify assert doc entry #45998
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
The `@assert` doc entry is somewhat confusing, first appearing to encourage then discourage its use. This attempts to clarify it for the general user.
Member
|
Is there a way to preserve the warning about side effects? This aspect seems important if the function opens a file or something like that. |
reintroduced the side-effects comment
Contributor
Author
|
I tried to rephrase it a little to improve the proposal, and reintroduced the |
KristofferC
reviewed
Aug 30, 2022
KristofferC
reviewed
Aug 30, 2022
LilithHafner
reviewed
Oct 3, 2022
Member
LilithHafner
left a comment
LilithHafner
left a comment
There was a problem hiding this comment.
@assert 7 throws. Perhaps we should mention @assert expr will throw unless expr evaluates to true.
IanButterworth
removed
the
merge me
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
The
@assertdoc entry is somewhat confusing, first appearing to encourage then discourage its use. This attempts to clarify it for the general user.