smiths / caseStudies

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

Comments on MIS #235

Closed Malavika-Srinivasan closed 5 years ago

Malavika-Srinivasan commented 5 years ago

@oluowoj @smiths

Hi Olu,

Please see my comments on your Unit VnV plan below.

  1. In the introductory blurb before section 3, it says "... testing each unit...". For consistency, can you please say modules instead of unit?

  2. A space missing between 'bodies' and 'This' in section 3.1 (4th line)

  3. For vector addition, can you add another test case from a different coordinate? Just for the sake of completion.

  4. Are you using cross product? If yes, I think you are missing test cases for cross product. I asked this because you mentioned in section 5.1.2 that this module provides cross products. If you re not using cross product, please ignore.

  5. There seems to be a missing `)' in UTC 22. (output field)

Thank you,

Malavika