search

smiths / caseStudies

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

Missing inputs? (MIS Review) #127

Closed elwazana closed 6 years ago

elwazana commented 6 years ago

@smiths Hello Dr. Smith, I am reviewing the MIS document and I found this. I'm not sure if this is an error or if this is how it should be;

calc_LR seems to only take NFL as input: image

But then it is calculated with GTF and LSF: image

The Drasil side also has GTF and LSF listed as inputs for LR: image

Should GTF and LSF be in the inputs list for calc_LR?

smiths commented 6 years ago

The variables that you highlighted are defined through the import of the Input module. We could quality them with Input.GTF etc, but then the equation doesn't look like it does in the SRS. We could also add notation to the import to say something like

Uses

GTF, LSF from Input (Section 5)

The problem with this is that we are using many of the parameters from Input and listing them all would be distracting. We could have a notation like Uses * from Input, but as it is, the default is to import everything, which should be fine.

I don't think there is a problem here, but if you have other ideas, please let me know.