Skip to content
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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

henrikt-ma
Copy link
Collaborator

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.


\begin{annotationdefinition}[absoluteValue]
\begin{synopsis}\begin{lstlisting}
/*literal*/ constant Boolean absoluteValue;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/*literal*/ constant Boolean absoluteValue;
/*literal*/ constant Boolean absoluteValue = true;

Should keep the default.

Copy link
Collaborator Author

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.

Copy link
Collaborator Author

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.

@HansOlsson
Copy link
Collaborator

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.

henrikt-ma and others added 2 commits December 20, 2024 10:40
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
@henrikt-ma
Copy link
Collaborator Author

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.

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.

@HansOlsson HansOlsson added this to the 2025-January milestone Jan 8, 2025
@HansOlsson
Copy link
Collaborator

Language group: looks good, avoids having annotations at different levels in toc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants