search

smiths / caseStudies

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

SI units correction #132

Closed elwazana closed 6 years ago

elwazana commented 6 years ago

As discussed in https://github.com/JacquesCarette/Drasil/issues/824, there are serious of symbols that need to convert from (mm -> m) and (kPa -> Pa). These changes need to be done in tables and in the equations which currently have a conversion factor.

Example:

This issue is specific to keep track of the changes to the manual documentation.

elwazana commented 6 years ago

These are the fixes so far, all of which are located here: 40f50e82c46e704625f87851262d06c43f615fb1 image @smiths Should dmax\min be converted to m as well?

Removed the conversion factors: image image

Typical value fix (Used to be 1500 mm and 1200 mm): image

smiths commented 6 years ago

Yes dmin and dmax should be converted to m.

elwazana commented 6 years ago

This is the only place where dmax and dmin were written as mm: 3a4e75a1950a4876aae88b0ad5f1950003b4390a image

I've also noticed and fixed a unit conversion for a and b that I missed before: image

smiths commented 6 years ago

Looks good. Can you search the document for instances of kPa as well? kPa should be changed to Pa, except for in Figure 7.

elwazana commented 6 years ago

Occurrences of kPa: image image

Fixed here: 7865849ee868085747bf74efde426b24ffd008b1 image image

smiths commented 6 years ago

Great!