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

Clarification of AsciiDoc formating #544

Open
APillekeit opened this Issue Mar 7, 2019 · 0 comments

Comments

Projects
None yet
3 participants
@APillekeit
Copy link
Collaborator

APillekeit commented Mar 7, 2019

first issue:

In the standard documentation it is in many cases required to describe "is equal to" relationships in case of XML attributes or general values e.g. return values of functions.

The proposal made at the FMI design meeting in Regensburg (March 2019) was to use natural language as much as possible.

examples:
...if variablity equals constant, then...
...if variablity equals constant or fixed, then...
...if the return value of fmi3Instantiate() equals NULL, then...

This should be added to the contributer guidlines

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.