How to: Do a review

Check List

The order

• model comment
• extend
• import (but should be avoid where possible)
• replacable package (e.g. Medium)
• parameter (only set a value, if it is almost a 100 % generic value)
• variables
• connectors
• component instances
• protected (within the protected part stick to the same order as above)

Points to take care of

• Do all paramaters, variables, models, etc. have a description?

• Use "group" and "tab" annotations in order to achieve a good visualization window?

• Stick to the Namespace Requirements and especially to the Variable Naming

• Use units

• For fluid models: Instantiate the replaceable medium package always as

  replaceable package Medium = Modelica.Media.Interfaces.PartialMedium "Medium model";

  instead of using directly a full media model like AixLib.Media.Water

• Absolute paths to classes! -> AixLib.Fluid.HeatExchangers.Radiator - Avoid: HeatExchangers.Radiator

• No Absolute paths to files! E.g. search for C: or D:. Replace with modelica://AixLib/...

• Is the documentation correct?

  • Read it carefully!
  • Do links work?
  • Revision section filled out?
  • AixLib.UsersGuide.Conventions

• Icons ok? (Avoid images!)

• Stick to 80 characters per line!

• Check model (F8 in Dymola)

• Check whole library (AixLib) (F8 in Dymola)

• Run examples of revised models

• HTML Check: Will be done by Travis CI

What might be helpful?

List of Changed Files

Open a (Windows) shell in the folder of your local repository:

git diff --name-only SHA1 SHA2 > C:\any_path\myList.txt

The expression > C:\any_path\myList.txt writes the list into a text file. Just leave this statement out in order to list the files directly in the shell.