Make it explicit that tools can show the value of variables for asserts #3641
Conversation
This file contains 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
See: modelica/ModelicaStandardLibrary#4519 and modelica/ModelicaStandardLibrary#4399 The reason for "may" is: - To not require the value to be duplicated, for cases such as: modelica/ModelicaStandardLibrary#4399 - Support even smarter debugging. I thought it was sufficiently important to make it normative.
henrikt-ma
reviewed
Jan 23, 2025
| @@ -506,6 +506,7 @@ \subsection{assert}\label{assert} | |||
| \lstinline!condition! needs to be implicitly treated with \lstinline!noEvent! since otherwise events might be triggered that can lead to slightly changed simulation results. | |||
| \end{nonnormative} | |||
| \end{itemize} | |||
| Tools may show more than the message for failed assertions, in particular the condition and the values of any variables used in it. | |||
There was a problem hiding this comment.
I find this too weak for purposes of guiding how library authors should formulate assert messages. Should they, or should they not explicitly include values of relevant variables in the message? Should they even mention names of problematic model variables?
There was a problem hiding this comment.
I tried to extend that.
There was a problem hiding this comment.
Specifically I view it as two parts:
- Models should just give a message. Nothing fancy - basically a literal string.
- For users the information (=condition and values of variables) should be accessible, but I want to leave that open for tools to innovate.
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.
See:
modelica/ModelicaStandardLibrary#4519 and modelica/ModelicaStandardLibrary#4399 for background.
The reason for "may" is:
I thought it was sufficiently important to make it normative.