-
Notifications
You must be signed in to change notification settings - Fork 44
Propose Solution for connectorSizing #3774
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
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
Co-authored-by: Henrik Tidefelt <henrikt@wolfram.com>
|
My suggested changes to the non-normative paragraph should have converged now. |
chapters/annotations.tex
Outdated
| The annotation allows a tool to perform these two actions in many cases automatically. | ||
| This is, e.g., very useful for state machines and for certain components of fluid libraries. | ||
|
|
||
| If a variable \lstinline!n! with \lstinline!connectorSizing = true! does not have exactly one associated vector of connectors, a diagnostic is recommended. |
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.
Now that the normative text says shall, I think this non-normative paragraph would make more sense without the recommendation to give diagnostics, leaving it to tools to figure out their own ways of dealing with misuse of the annotation.
Github doesn't let me comment on the entire paragraph of three lines, but this suggestion is meant to replace the entire paragraph:
If a variable \lstinline!n! with \lstinline!connectorSizing = true! has multiple associated vectors of connectors, some of the graphical operations described below will not work reliably.
If there is no associated vector of connectors, the user may choose to address this by removing the \lstinline!connectorSizing! annotation.
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.
I have now added with slight modification.
Closes #3772
It explains the existing use of
n+0.I use "should" to not discuss the edge-cases, in particular:
nwill work in some cases, but not in all cases.