smiths / caseStudies

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

State Variables in 5.4 State Variables in GlassBR MIS #135

Closed samm82 closed 6 years ago

samm82 commented 6 years ago

The State Variables are listed as so (a to t):

But the specification for load_params(s) says "(a to w)," which implies that the State Variables list is sorted alphabetically.

Should the list be sorted alphabetically, or should the procedure for load_params(s) be changed to "(a to t)?

smiths commented 6 years ago

I would like the list in the same order as the SRS, R1. We should remove the text (a to w). It isn't necessary, and it will be difficult to maintain manually. Can you please look at the SRS and modify the MIS state variable order, if necessary.

samm82 commented 6 years ago

Should the same change should be made for the list from SRS R2?