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

Clearer protection #3629

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

Conversation

HansOlsson
Copy link
Collaborator

Closes #3622

In particular:

  • Be consistent with examples, I don't know why we have claimed that "Authorization" was in Protection.
  • Be more explicit with nested records.

end Protection;

record IntLicense "Internal class name, do not use"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Wouldn't it look cleaner like this,

Suggested change
record IntLicense "Internal class name, do not use"
record IntLicense "Type of Protection.License"

or without any description at all?

Suggested change
record IntLicense "Internal class name, do not use"
record IntLicense

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The problem is that we want to avoid two things:

  • Use of the class name, i.e., annotation(Protection(License=UserLicense(...
  • Having annotations of the form annotation(UserLicense(libraryKey=... (as if were a normal annotation-record).

To me just saying that the class name is internal seems the simplest way to achieve that.

An alternative to this description would be to have it as a separate segment and state that it is internal before that.

/*literal*/ constant String expirationDate = "" "Optional expiration date in UTCformat YYYY-MM-DD";
/*literal*/ constant String operations[:] "Library usage conditions";
end License;
\end{lstlisting}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Somewhere below here, the default behaviors should be explained:

Suggested change
\end{lstlisting}
\end{lstlisting}
If \lstinline!startDate! or \lstinline!expirationDate! are empty (the default), the license has no start day or expiration date, respectively.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Will add a reformulated version.

Copy link
Collaborator

@henrikt-ma henrikt-ma left a comment

Choose a reason for hiding this comment

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

The cleanup looks good to me, but since System Modeler does not implement this annotation, I am not in a good position to provide a review with approval.

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.

How to use the Protection annotation(s)
2 participants