search

smiths / caseStudies

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

Wording updates in NoPCM Assumptions #113

Closed niazim3 closed 6 years ago

niazim3 commented 6 years ago

Upon comparing the NoPCM's list of assumptions for JacquesCarette/Drasil/issues/843, I noticed the following discrepancies seem like quick fixes:

  1. Drasil generates "... between the heating coil and the water", whereas the manual version has image

  2. Drasil generates "... is always in liquid state...", whereas the manual version has image

@smiths, is it alright for the wording in Drasil to be propagated to this repo?

smiths commented 6 years ago

@niazim3 thank you for noticing these differences. I agree that the Drasil wording is better. @elwazana, it would be great if you could propagate these changes.

niazim3 commented 6 years ago

Found one more discrepancy upon inserting missing assumptions into Drasil:

Drasil generates "... volumetric heat generation per unit volume is zero..." whereas the manual version has image

elwazana commented 6 years ago

@smiths Is the change @niazim3 mentioned approved for propagation?

smiths commented 6 years ago

Yes, please proceed.