Start of cleanup of wording in terminals section #1885
Merged
Conversation
This file contains 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
pmai
requested review from
t-sommer,
klausschuch,
chrbertsch,
andreas-junghanns and
TorstenBlochwitz
(also following Andreas' suggestion)
klausschuch
reviewed
Jun 11, 2023
docs/2_4_common_schema.adoc
Outdated
| @@ -1743,9 +1743,9 @@ The following <<dependenciesKind>> is only allowed for floating point latexmath: | |||
|
|
|||
| ==== Terminals and Icons [[fmiTerminalsAndIcons]] | |||
|
|
|||
| Terminals define semantic groups of variables to ease connecting compatible signals on the system level. | |||
| Terminals define semantic groups of variables to ease connecting compatible variables on the system level. | |||
There was a problem hiding this comment.
I'd either write (a) "Terminals define semantic groups of variables." or (b) "Terminals define semantic groups of variables. Such groups can for example be used to ease connecting compatible variables on the system level."
I prefer (a) since later on "...into logical groups, e.g., to ease connections on a system level..." is used anyway.
klausschuch
reviewed
Jun 11, 2023
Co-authored-by: Klaus Schuch <[email protected]>
chrbertsch
approved these changes
Jun 19, 2023
andreas-junghanns
approved these changes
Jun 20, 2023
klausschuch
reviewed
Jun 20, 2023
klausschuch
approved these changes
Jun 20, 2023
Co-authored-by: Klaus Schuch <[email protected]>
|
If there are no further review comments, I will merge this PR this evening, in order to create a FMI3.0.1rc3 and proceed with the release process. |
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.
This starts the clarification of the terminals section in terms of unclear or misleading wording, especially unintentional narrowing on inputs and outputs as discussed in the design meeting on 2023-06-06