Use more overview tables for annotations #3628
Open
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
HansOlsson
reviewed
Dec 17, 2024
| \tablehead{Annotation} & \tablehead{Description} & \tablehead{Details}\\ | ||
| \hline | ||
| \hline | ||
| {\lstinline!singleInstance!} & Allow at most one instane & \Cref{modelica:singleInstance}\\ |
There was a problem hiding this comment.
Suggested change
| {\lstinline!singleInstance!} & Allow at most one instane & \Cref{modelica:singleInstance}\\ | |
| {\lstinline!singleInstance!} & Allow at most one instance & \Cref{modelica:singleInstance}\\ |
HansOlsson
reviewed
Dec 17, 2024
| \hline | ||
| {\lstinline!singleInstance!} & Allow at most one instane & \Cref{modelica:singleInstance}\\ | ||
| {\lstinline!mustBeConnected!} & Connector must be connected at least once & \Cref{modelica:mustBeConnected}\\ | ||
| {\lstinline!mayOnlyConnectOnce!} & Connector must be connected at most once & \Cref{modelica:mayOnlyConnectOnce}\\ |
There was a problem hiding this comment.
Description should be consistent with the name:
Suggested change
| {\lstinline!mayOnlyConnectOnce!} & Connector must be connected at most once & \Cref{modelica:mayOnlyConnectOnce}\\ | |
| {\lstinline!mayOnlyConnectOnce!} & Connector may at most be connected once & \Cref{modelica:mayOnlyConnectOnce}\\ |
HansOlsson
reviewed
Dec 17, 2024
|
|
||
| \begin{annotationdefinition}[absoluteValue] | ||
| \begin{synopsis}\begin{lstlisting} | ||
| /*literal*/ constant Boolean absoluteValue; |
There was a problem hiding this comment.
Suggested change
| /*literal*/ constant Boolean absoluteValue; | |
| /*literal*/ constant Boolean absoluteValue = true; |
Should keep the default.
|
I can understand that this helps, but my concern with adding such tables is that it is a form of duplicated information, which adds a maintenance burden. |
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.
This improves the presentation of some sections in the Annotations chapter, by applying the kind of overview table which is used, for example, in 18.7 Simulations.
This change was triggered by me trying to get an overview of the existing annotations, which isn't easy in in the unstructured sections. More sections could be restructured similarly, but I am keeping down the size of this PR by only taking care of two sections in pressing need, and where the transformation is straight-forward.
Also fixing some minor issues which appear to be results of the recent work on formalizing the notation.