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
henrikt-ma
reviewed
Feb 6, 2025
henrikt-ma
reviewed
Feb 6, 2025
Co-authored-by: Henrik Tidefelt <[email protected]>
Co-authored-by: Henrik Tidefelt <[email protected]>
henrikt-ma
reviewed
Feb 24, 2025
| @@ -518,6 +519,11 @@ \subsection{assert}\label{assert} | |||
| AssertionLevel.warning); | |||
| assert(T > 200 and T < 500, "Medium model outside feasible region"); | |||
| \end{lstlisting} | |||
|
|
|||
| It is recommended that asserts have a simple message as above, formulated with the recommended tool behavior in mind. | |||
| Tools are recommended to include the failed condition in the message. | |||
There was a problem hiding this comment.
This was already stated above.
Suggested change
| Tools are recommended to include the failed condition in the message. |
henrikt-ma
reviewed
Feb 24, 2025
|
|
||
| It is recommended that asserts have a simple message as above, formulated with the recommended tool behavior in mind. | ||
| Tools are recommended to include the failed condition in the message. | ||
| Tools are also (especially for literal strings) recommended to automatically include the values of relevant variables, as part of the log or interactively accessible. |
There was a problem hiding this comment.
Essentially already stated above.
Suggested change
| Tools are also (especially for literal strings) recommended to automatically include the values of relevant variables, as part of the log or interactively accessible. |
henrikt-ma
reviewed
Feb 24, 2025
| It is recommended that asserts have a simple message as above, formulated with the recommended tool behavior in mind. | ||
| Tools are recommended to include the failed condition in the message. | ||
| Tools are also (especially for literal strings) recommended to automatically include the values of relevant variables, as part of the log or interactively accessible. | ||
| Writing \lstinline!assert(T<500, "Temperature = "+String(T)+" was above 500");! is thus not recommended, and is likely to lead to duplicated information -- although tools may have specific compatibility handling of such cases. |
There was a problem hiding this comment.
It should be sufficient to say likely; just let tools to their "clever" thing without mentioning it in the specification. Also remove punctuation at end of inline code:
Suggested change
| Writing \lstinline!assert(T<500, "Temperature = "+String(T)+" was above 500");! is thus not recommended, and is likely to lead to duplicated information -- although tools may have specific compatibility handling of such cases. | |
| Writing \lstinline!assert(T<500, "Temperature = "+String(T)+" was above 500")! is thus not recommended, and is likely to lead to duplicated information. |
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.