Improve documentation on heat pump examples
Created by: marcusfuchs
What is the problem?
- Just as #373 (closed) and #390 (closed) , the example models
AixLib.Fluid.HeatPumps.Examples.HeatPumpDetailed
andAixLib.Fluid.HeatPumps.Examples.HeatPumpSimple
contain elements that are missing a doc-string. See #373 (closed) for a detailed description of the problem. - In addition, both models contain a typo in their documentation:
consumptiion
should beconsumption
.
Why do we want to solve it?
- Documentation strings make it a lot easier for everyone to quicker and better understand the model
- This is a good first issue (not much effort and expertise are needed to fix this)
How do we want to solve it?
- Again, see #373 (closed) and the corresponding pull request #388 for guidance on how to solve this.
- Follow our tutorial for first-time contributors
- Feel free to adress one or both of the models mentioned above in your pull request.