search

smiths / caseStudies

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

Add Unlikely Changes section to gamephys. #102

Open Mornix opened 6 years ago

Mornix commented 6 years ago

Unlikely changes for gamephys SRS for #100.

screen shot 2018-06-20 at 4 00 38 pm
smiths commented 6 years ago

I like UC1, but I don't think we need UC2. Although the document is written for 2D, the equations look very similar for 3D physics. If we wrote things just a little more abstractly, changing from 2D to 3D could be considered as a likely change.

Mornix commented 6 years ago
screen shot 2018-06-20 at 5 07 55 pm
smiths commented 6 years ago

Sounds good, but I suggest that you remove the introduction sentence. That is, remove "If changes were made ...". It isn't just the algorithm that will change. The theory changes, data structures may change, etc. The heading of the section can be the introduction. So you can go right into the list.

samm82 commented 6 years ago

@Mornix this branch has conflicts with master

Mornix commented 6 years ago

These PR’s slipped my mind. Thanks for the reminder!