smiths
commented
6 years ago I've copied the markdown text from above. I'll now edit in my comments.
The following is a list of inconsistencies in the [Game Physics SRS] (https://github.com/smiths/caseStudies/blob/master/CaseStudies/gamephys/documentation/SRS/GamePhysicsSRS.pdf):
- [ ] Section 4.1.1 The terms themselves are inconsistently capitalized. The first three terms are capitalized like they are titles, while the last two only capitalize the first letter.
Good catch. As you comment implies, consistency is the key. I don't actually have a rule for this type of capitalization; I just want it to be consistent. Can you please update the capitalization, going in whatever direction is the least amount of work. Does the Drasil code have the same problem? It would be nice if Drasil auto-generated capitalization, so that the text was always consistent. Even better if we could control the style of capitalization with a user configurable input. 😄
- [ ] Section 4.2.5 (IM3's Output) It appears that the equations for the AB collision pair are using a different notation to describe velocity before and after the collision. The AB collision pair use v(t) for before (v_i) and v(t_c) for after (v_f).
Another good catch. I prefer the notation that uses the function of time approach, instead of the subscript approach. Would it be feasible to update the manual case study and the Drasil generated code to use this approach?
- [ ] Section 5.1 (R5 and R6) R5's positions and velocities changes are due to a force acting on a rigid body, but R6 makes no mention of a force.
Good catch. Please add a reference to the force acting on the body to R6.
- [ ] Section 5.1 (R5, R6, and R8) All three requirements mention position in the singular and velocity in the plural.
Good! Please make everything plural.
- [ ] Section 1.2, Section 4.2.6 (Table 1) Gravity is a vector yet the g in both tables is not bolded.
1.2 Table of Symbols
4.2.6 Data Constraints (Table 1)
We can leave this one as it is, since g in the tables is the acceleration toward the centre of the earth due to gravity, which is a scalar value.
(Issue #29)
The following is a list of inconsistencies in the Game Physics SRS:
[ ] Section 4.1.1 The terms themselves are inconsistently capitalized. The first three terms are capitalized like they are titles, while the last two only capitalize the first letter.
[ ] Section 4.2.5 (IM3's Output) It appears that the equations for the AB collision pair are using a different notation to describe velocity before and after the collision. The AB collision pair use v(t) for before (v_i) and v(t_c) for after (v_f).
[ ] Section 5.1 (R5 and R6) R5's positions and velocities changes are due to a force acting on a rigid body, but R6 makes no mention of a force.
[ ] Section 5.1 (R5, R6, and R8) All three requirements mention position in the singular and velocity in the plural.
[ ] Section 1.2, Section 4.2.6 (Table 1) Gravity is a vector yet the g in both tables is not bolded. 1.2 Table of Symbols
4.2.6 Data Constraints (Table 1)