search

smiths / caseStudies

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

Punctuation for equations with cases #216

Closed bmaclach closed 5 years ago

bmaclach commented 5 years ago

I noticed while revising SSP that when an equation has cases, there is sometimes a comma after each case but before the case predicate, as in DD4 below: image

And sometimes there is no punctuation, as in IM3: image

I want to make these consistent but do not know which format is better. @smiths do you have a preference for commas or no commas?

smiths commented 5 years ago

@bmaclach, I prefer it without the commas, but my preference isn't a strong one. As you have said, the most important thing is consistency.

JacquesCarette commented 5 years ago

Without the comma!

bmaclach commented 5 years ago

Thank you both! I'll remove the commas where they occur. Since this issue was intended as a question, I'll go ahead and close it.