search

smiths / caseStudies

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

Capitalization of Outputs in SRS #108

Closed samm82 closed 6 years ago

samm82 commented 6 years ago

There is inconsistent capitalization of the list of outputs in Functional Requirement #6

outputs

EDIT: They should all be lowercase, as that's how they are typed in the rest of the document.

smiths commented 6 years ago

@samm82 you are correct. I would like the capitalization to be consistent, but I don't really have a preference for which way to go. They important thing is consistency. We should follow how the capitalization is done throughout the rest of the document. I believe this means that the sub-terms should have capitals. For instance, I think Applied load should be Applied Load. Can you please verify? If the rest of the document uses this kind of capitalization, please propagate this change.

samm82 commented 6 years ago

I thought they should be capitalized, but throughout the document, they're only capital if they're in a title and lowercase everywhere else, so I'll make them lowercase.

Also, everywhere but this list, Non-factored load has a hyphen, so I'll make that change too

Should I check if this is in Drasil too? @smiths

smiths commented 6 years ago

Sounds like a great plan. Yes, please make the changes in Drasil too. As trivial as it is, in the future Drasil should prevent us from having to worry about these kind of consistencies. @szymczdm, this might be a point that you can make in your journal paper? Even better, if we decide to change the style of capitalization, this is something we will eventually be able to specify.

samm82 commented 6 years ago

The list of outputs is consistent (with the exception of Aspect Ratio) in Drasil @smiths, but it has a different list of outputs. Should I close this and make a new issue there?

caseStudies List

Probability of breakage (Pb) Risk of failure (B) Load resistance (LR) Applied load (demand) (q) Stress distribution factor (J) - near the end in Drasil Non-factored load (NFL) Dimensionless load (q̂) Tolerable load (q̂tol) Stress distribution factor based on Pb (Jtol)

Drasil List

Probability of breakage (Pb) Load resistance (LR) Applied load (demand) (q) Non-factored load (NFL) Glass type factor (GTF) Dimensionless load (q̂) Tolerable load (q̂tol) Stress distribution factor (Function) based on Pbtol (Jtol) Stress distribution factor (Function) (J) Actual thickness (h) Aspect Ratio (AR)

smiths commented 6 years ago

@samm82, I believe there is already an issue for this:

https://github.com/JacquesCarette/Drasil/issues/785

I didn't get into the details, but the point of the issue is to update the Drasil SRS to match the revisions to the manual version. The revisions include the changes you have mentioned.

samm82 commented 6 years ago

You're right - didn't make the correlation here. This issue can be closed then.