document the inplace and check keyword arguments#5910
Merged
fingolfin merged 2 commits intooscar-system:masterfrom Apr 8, 2026
Merged
document the inplace and check keyword arguments#5910fingolfin merged 2 commits intooscar-system:masterfrom
inplace and check keyword arguments#5910fingolfin merged 2 commits intooscar-system:masterfrom
Conversation
ThomasBreuer
added
documentation
fingolfin
reviewed
Apr 1, 2026
Comment on lines
+46
to
+48
| The boolean valued keyword argument `check` is recommended for this purpose, | ||
| the `@req` macro can be used to execute the check and to throw an | ||
| `ArgumentError` if it fails. |
Member
There was a problem hiding this comment.
Maybe also the @check macro defined in src/assertions.jl should be mentioned?
fingolfin
approved these changes
Apr 1, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
motivated by #5907