search

smiths / caseStudies

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

Inconsistency within "from (SRS)" comments in MIS (GlassBR) #126

Closed niazim3 closed 6 years ago

niazim3 commented 6 years ago

image

Can the comments be updated to "#From SRS R#" to match the traceability comments in the rest of the MIS? (e.g. https://github.com/smiths/caseStudies/blob/71fd801e7c88d4ab7bf06da62eb6d79a9a1c0d2c/CaseStudies/glass/docs/Design/MIS/glassbr_mis.tex#L169 https://github.com/smiths/caseStudies/blob/71fd801e7c88d4ab7bf06da62eb6d79a9a1c0d2c/CaseStudies/glass/docs/Design/MIS/glassbr_mis.tex#L172-L173)

elwazana commented 6 years ago

I've also found these in Section 5.4.4: image

Section 13.4.5: image

smiths commented 6 years ago

Yes, adding "from SRS" is better.

elwazana commented 6 years ago

@smiths Hello Dr. Smith, I've fixed the consistency problem here, these are the changes and commit: a29d1338306d93332e82edf0d215f48b3a6e2515 image image image

smiths commented 6 years ago

Great!