-
Notifications
You must be signed in to change notification settings - Fork 166
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
Refs #3593: Fix documentation of quasi-static machine examples #3620
Conversation
The following models use the instance name
@tobolar @beutlich Are we allowed to rename a sensor in the master branch? If yes, I would unify the appearance of the sensor names. |
There is one more issue with a synchronous machine example which I am going to fix. |
...agnetic/QuasiStatic/FundamentalWave/Examples/BasicMachines/InductionMachines/IMC_Conveyor.mo
Show resolved
Hide resolved
Do you mean to rename a sensor element in that particular example model? |
Yes, this is what I mean |
IMO this is no problem when only an example is concerned. I remember there has been some comment on it by (I guess) @dietmarw but I can't find it anymore. |
First of all you need to determine what is meant by "master branch". The question is what next version the master branch is aiming at. Backward compatible, i.e., 4.1.0, or non-backward compatible, i.e., 5.0.0. As far as I know this has not yet been decided within MAP-LIB. In the latter case there is no restrictions on renames as long as conversion scripts are given. In the former case we tended to allow renames within examples even if they break backward compatibility since the argument is that users should not let their usermodels extend from examples (copying is fine but not extend). |
00fc905
to
a76bc58
Compare
OK, I propose to separate the issues which became mixed up in this PR.
So if there are not objections with this approach, I am asking @tobolar and @dietmarw to re-evaluate this PR so that we can proceed. |
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.
Looks good to me. I don't think parentheses would be strictly necessary in case of the choices but would not harm either. I leave that to the LOs to decide.
a76bc58
to
97077ba
Compare
I've rebased the PR on current master in order to get the CI checks working. |
I checked the quasi static induction machine examples and updated the documentation to match the actual variables.