smiths / caseStudies

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

MIS Peer Review Issue #5 #230

Closed whitere123 closed 5 years ago

whitere123 commented 5 years ago

Hello @vajihehm ,

This issue is regarding section 11 (ContoursADT) of your MIS document.

smiths commented 5 years ago

@whitere123 you are correct that ideally code is not part of the specification for a module. The goal is to provide a state based specification - a specification that says what should happen, but not the steps for its calculation. However, there are cases where this kind of specification is difficult to write, or more confusing than it has to be. In those cases we can use a procedural specification. It is still a specification, just a different form.