search

smiths / caseStudies

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

Data Constraints AR row #136

Closed elwazana closed 6 years ago

elwazana commented 6 years ago

As discussed in issue #129, AR will be getting its own row in the InputDataConstraints table. Instead of being weaved into a and b's rows.

Current Manual:

smiths commented 6 years ago

Good. #137 is also related to this constraint.

elwazana commented 6 years ago

Intial occurence of AR in the Data Constraints: image

Newly modified table: image

These changes are to the SRS document of GlassBR and they can be found here: ef855ec3c8e70be006704b02daaa6de0b05d5255

smiths commented 6 years ago

Looks good. A minor suggestion is to move AR after a and b in the table. I think it would look better. (I think that change would also match an alphabetical listing that is case sensitive, with lower case first.)

elwazana commented 6 years ago

@smiths In Drasil the table is ordered alphabetically with case sensitive in mind, however, that just means a goes before A not b goes before A; this means the case sensitivity is per letter not per table. Also if we made the tables order lower case first before capitalization for every letter, then w would be bumped up here.

Drasil: image

smiths commented 6 years ago

Okay. Makes sense.