smiths / caseStudies

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

[GamePhys MIS Review #3] Comments About the Notation #223

Closed hananezlitni closed 5 years ago

hananezlitni commented 5 years ago

Hi @oluowoj ,

I suggest explaining the notation you used in defining new data types and the values of the variables in the notation section, so the reader could understand it easily.

I also suggest reading section 3.4 (page 29) of the “Hoffman and Strooper 1995” paper, that explains a way to define data types and values. The paper is available in the course repo.