-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use more overview tables for annotations #3628
base: master
Are you sure you want to change the base?
Conversation
|
||
\begin{annotationdefinition}[absoluteValue] | ||
\begin{synopsis}\begin{lstlisting} | ||
/*literal*/ constant Boolean absoluteValue; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/*literal*/ constant Boolean absoluteValue; | |
/*literal*/ constant Boolean absoluteValue = true; |
Should keep the default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In 3.6 it wasn't clear that there was a default, and I consider the specification of default an accident of the change of notation. Hence, I think we should open a separate discussion about how to describe the default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is now the topic of #3631.
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. |
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Yes, it is a bit of maintenance burden, but at least to me the burden is easily motivated by the tremendous help it provides me when navigating the document. |
Language group: looks good, avoids having annotations at different levels in toc. |
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.