search

smiths / caseStudies

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

Game Physics: MG Inconsistency #72

Closed Mornix closed 6 years ago

Mornix commented 6 years ago

(Issue #29)

The Game Physics MG has an inconsistency between Section 5 and Section 6.

Section 5 refers to the modules in some programming language in the general sense while Section 6 makes direct mention of the C modules which seems like an inconsistency between the sections.

screen shot 2018-05-09 at 11 20 52 pm screen shot 2018-05-09 at 11 21 05 pm
smiths commented 6 years ago

Agreed. The MG should be language agnostic, if at all possible. It certainly is possible in this case. Can you please modify the MG so that Section 6 mentioned implemented code files, not specifically C files.