search

smiths / caseStudies

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

Scientific Notation in 14.3.1 of MIS #122

Closed samm82 closed 6 years ago

samm82 commented 6 years ago

In Section 14.3.1 Exported Constants, and as per JacquesCarette/Drasil#886, there should be explicit scientific notation where highlighted.

sci not

smiths commented 6 years ago

You mean that the multiplication symbol should be added? That would be fine, but the current version was copied out of the SRS. I was trying to keep them consistent.

samm82 commented 6 years ago

Since the end goal is to have the multiplication symbol in the Drasil SRS, I think we should change this, especially as it has been added to the manual SRS, but I'll wait for your approval.

smiths commented 6 years ago

Okay, go ahead an add the multiplication symbol to the MIS. I do prefer it being there. It may be a bit before Drasil will match the case study version.

smiths commented 6 years ago

We are hoping to discuss multiplication in our "all hands" meeting tomorrow (July 24). @szymczdm will be creating an issue describing how the printer will be changed in Drasil to automate the use of the multiplication symbol between constants and variables, and for displaying large and small literals.