Text improvements to 2.4 and 2.5 #1702
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
|
This PR reflects @TorstenBlochwitz and my (@andreas-junghanns) changes of the last 2 days. |
t-sommer
requested changes
Mar 1, 2022
| @@ -185,7 +185,7 @@ The following table lists the most common platform tuples for shared libraries a | |||
|
|
|||
| If runtime libraries are needed by the FMU that have to be present on the target machine and cannot be shipped within the FMU (e.g., due to licensing issues), then automatic processing is likely impossible. | |||
| In such cases special handling is needed, for example, by providing the runtime libraries at appropriate places by the receiver. | |||
| The requirements and the expected processing should be documented in the `documentation` directory in this case. + | |||
| The requirements and the expected processing must be documented in the `documentation` directory in the file `externalDependencies.{txt|html}`. + | |||
There was a problem hiding this comment.
Not sure if we should have "must" here. This boils down to "you should not ship poorly documented FMUs"...
There was a problem hiding this comment.
The alternative is to say: "Let´s not define things, people will not do it right anyway."
Poorly documented FMUs that are not running because the user does not know what to do should be blamed on the exporter - and this "must" is a blame distribution mechanism.
In the end, we express our expectation, knowing about the reality...
klausschuch
reviewed
Mar 1, 2022
klausschuch
reviewed
Mar 1, 2022
Co-authored-by: Klaus Schuch <klaus.schuch@avl.com>
t-sommer
approved these changes
Mar 2, 2022
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.
No description provided.