Page MenuHome

better definition of smoke + eg replaces ie + question of style
ClosedPublic

Authored by Julian (juliand) on Apr 5 2018, 9:51 AM.

Details

Summary

the definition of smoke used was too restrictive - smoke is not just gases. i have borrowed from wikipedia, which seemed to have the most useful and succinct definition of smoke.

i also changed i.e. to e.g. because ie means 'that is' and what is clearly intended is 'for example' or exempli gratia = eg.

on the matter of commas in abbreviations, there is lively debate online, and it does seem that the chicago style of e.g. is being slowly replaced either by no commas at all or just one comma at the end. one thinks of USA, GB, etc. i have stuck with chicago style as that is what the existing author has used. in the style guide for blender docs i did not see any reference to chicago or any other external style guide. maybe i missed it. if there is such a reference, i would be grateful to know where it was.

Diff Detail

Event Timeline

This revision is now accepted and ready to land.Apr 5 2018, 3:48 PM

It's not necessary to mention developers in docs patch reviews, unless you are changing something really big or you have a doubt about how a feature actually works. Regarding the style, there is no strict guideline besides "clarity". Having something along these lines would be nice.

@Julian (juliand) can you commit your changes from this patch?