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
Comment on lines
+524
to
+525
| Tools are (especially for simple messages) recommended to automatically include the values of relevant variables, as part of the log or interactively accessible. | ||
| Similarly tools are recommended to include the failed condition. |
There was a problem hiding this comment.
This is already part of the normative text above, so it needs to be removed or reformulated with the user in focus:
Suggested change
| Tools are (especially for simple messages) recommended to automatically include the values of relevant variables, as part of the log or interactively accessible. | |
| Similarly tools are recommended to include the failed condition. | |
| In this case, for example, embedding the value of \lstinline!T! in the message is likely to result in duplicated information and should be avoided. |
There was a problem hiding this comment.
The idea with "especially for simple messages" was to allow tools to skip the duplicated T in such cases.
There was a problem hiding this comment.
Basically to allow good compatibility with existing models that already have such complicated messages, but provide a simple recommendation for users.
There was a problem hiding this comment.
Ok, tools may be smarter for a transition
Co-authored-by: Henrik Tidefelt <[email protected]>
Co-authored-by: Henrik Tidefelt <[email protected]>
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.