Apply modern table presentation to Versions #3737
Open
Conversation
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
HansOlsson
reviewed
Oct 1, 2025
|
|
||
| \begin{annotationdefinition}[version] | ||
| \begin{synopsis}\begin{lstlisting} | ||
| /*literal*/ constant String version |
There was a problem hiding this comment.
Suggested change
| /*literal*/ constant String version | |
| /*literal*/ constant String version; |
I thought the original idea was to have a full declaration with semi-colon.
I noticed that one of the recent updates also skipped that.
HansOlsson
reviewed
Oct 1, 2025
| "script" "=" STRING | ||
| | "change" "(" [ conversion-rule { "," conversion-rule } ] ")" | ||
|
|
||
| conversion-rule : STRING |
There was a problem hiding this comment.
Suggested change
| conversion-rule : STRING | |
| conversion-rule : IDENT function-call-args |
These are supposed to be calls of the conversion-functions.
HansOlsson
reviewed
Oct 1, 2025
| /*literal*/ constant String version | ||
| \end{lstlisting}\end{synopsis} | ||
| \begin{semantics} | ||
| \lstinline!version = $\mathit{currentVersion}$! where is a \lstinline[language=grammar]!PACKAGE-VERSION-STRING! defines the version number of the model or package. |
There was a problem hiding this comment.
Suggested change
| \lstinline!version = $\mathit{currentVersion}$! where is a \lstinline[language=grammar]!PACKAGE-VERSION-STRING! defines the version number of the model or package. | |
| \lstinline!version = $\mathit{currentVersion}$! where is a \lstinline[language=grammar]!PACKAGE-VERSION! defines the version number of the model or package. |
The syntax for package versions currently use PACKAGE-VERSION
HansOlsson
reviewed
Oct 1, 2025
|
|
||
| conversion : conversion-none | conversion-with-rules | ||
|
|
||
| conversion-none : "noneFromVersion" "=" PACKAGE-VERSION-STRING |
There was a problem hiding this comment.
Suggested change
| conversion-none : "noneFromVersion" "=" PACKAGE-VERSION-STRING | |
| conversion-none : "noneFromVersion" "=" PACKAGE-VERSION |
Same
HansOlsson
reviewed
Oct 1, 2025
| conversion-with-rules : | ||
| "from" "(" | ||
| "version" = package-versions | ||
| [ "," "to" "=" PACKAGE-VERSION-STRING ] |
There was a problem hiding this comment.
Suggested change
| [ "," "to" "=" PACKAGE-VERSION-STRING ] | |
| [ "," "to" "=" PACKAGE-VERSION ] |
Same
HansOlsson
reviewed
Oct 1, 2025
|
|
||
| used-package : | ||
| IDENT "(" | ||
| "version" "=" PACKAGE-VERSION-STRING |
There was a problem hiding this comment.
Suggested change
| "version" "=" PACKAGE-VERSION-STRING | |
| "version" "=" PACKAGE-VERSION |
Same
HansOlsson
reviewed
Oct 1, 2025
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.
After this, we can think more about how to express this kind of annotation in the record style.