search

smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

SolarHeatingWaterOnly_SRS: Clarity Issue #59

Open elwazana opened 6 years ago

elwazana commented 6 years ago

In section 6, LC3 mentions the charging and discharging of the tank. However, it may make the sentence clearer by mentioning that this is in reference to the temperature of the tank, rather than leave it as ambiguous "charging/discharging".

smiths commented 6 years ago

@elwazana can you pull the text from the original and reproduce it in your issue? It will make it much faster to review. You can also assign issue like this to me.

elwazana commented 6 years ago

LC3: A9 - The model currently only accounts for charging of the tank. A more complete model would also account for discharging of the tank.

smiths commented 6 years ago

I guess it wasn't faster (in this case) to put the text together with the issue. 😄

You are correct that the charging terminology may not be familiar to all of the readers. How about:

"LC3: A9 - The model currently only accounts for heating of the tank. That is, increasing the temperature of the water and the PCM to match the temperature of the coil. A more complete model would also account for cooling of the tank."

Please also make this change in the Drasil code.