Add recommendation for code formatting (and apply it)

[HansOlsson]

Add some description of how we want code to be formatted, and apply the rules.
Some minor items to clean up.

[tobolar]

@HansOlsson I miss a notice how to indentate multi-line declarations.
And, a code example could be helpfull as well.

[HansOlsson]

@HansOlsson I miss a notice how to indentate multi-line declarations. And, a code example could be helpfull as well.

I tried to add both of them.

[tobolar]

I'm in favor with this suggestion.
Even if we could go farther similar to Python's PEP8 - Indentation it would be probably too restrictive for now.

[HansOlsson]

@casella as new MAP-Lib leader I hope you approve of this.

[HansOlsson]

@casella @henrikt-ma can you review it - so that it can be merged before release-branch on Friday January 12th?

[HansOlsson]

I have now rebased it on master and removed three new cases of trailing white-space. It would be good if this could be approved and merged, @casella @henrikt-ma

[henrikt-ma]

The conventions look sensible, and I can't spot anything obviously wrong with the included changes.

What I'd like to avoid however, is the risk of styling conventions for the Modelica Standard Library to be taken as conventions that should apply to all Modelica code. To avoid this, I suggest changing this sentence:

ModelicaStandardLibrary/Modelica/package.mo

Line 2281 in 0e0f5d3

<p>A Modelica main package should be compliant with the UsersGuide stated in this documentation:</p>

Something like this would make more sense to me:

<p>A Modelica main package of the Modelica Standard Library should be compliant with the UsersGuide stated in this documentation:</p>

By the way, I had never heard of a Modelica main package until I saw this line – is it a generally recognized term? Does it mean the same as what I'd refer to as an MSL sub-library?

[henrikt-ma]

I have now rebased it on master and removed three new cases of trailing white-space. It would be good if this could be approved and merged, @casella @henrikt-ma

Please avoid rebasing, as it breaks GitHub conversations linked to commits. For example, I was unable to find my previous review comments in order to see if and how they had been addressed.

[HansOlsson]

I have now rebased it on master and removed three new cases of trailing white-space. It would be good if this could be approved and merged, @casella @henrikt-ma

Please avoid rebasing, as it breaks GitHub conversations linked to commits. For example, I was unable to find my previous review comments in order to see if and how they had been addressed.

Rebasing is unfortunately needed to ensure easier merging - as the status was too messy, but that's why it should only be done after addressing the comments.

[HansOlsson]

The conventions look sensible, and I can't spot anything obviously wrong with the included changes.

What I'd like to avoid however, is the risk of styling conventions for the Modelica Standard Library to be taken as conventions that should apply to all Modelica code. To avoid this, I suggest changing this sentence:

ModelicaStandardLibrary/Modelica/package.mo

Line 2281 in 0e0f5d3

<p>A Modelica main package should be compliant with the UsersGuide stated in this documentation:</p>

Something like this would make more sense to me:

<p>A Modelica main package of the Modelica Standard Library should be compliant with the UsersGuide stated in this documentation:</p>

By the way, I had never heard of a Modelica main package until I saw this line – is it a generally recognized term? Does it mean the same as what I'd refer to as an MSL sub-library?

That line wasn't changed; and the UsersGuide already contained recommendations that could get into that problem.

So, once more: don't block PRs based on other existing issues

[henrikt-ma]

OK, the potential risk of these guidelines being misinterpreted as applying to all Modelica code (not just in the MSL) isn't new and will be reported separately.