covid-sim
covid-sim copied to clipboard
Create paramaters-description.md
This file explains the purpose of the paramaters class, groups variables by type to aid legibility and provides a description of each variable
This seems like a good idea. You might want to keep an eye on some of the int parameters changing to bool- I can seem some changes in the param.h overnight.
Also parameter not paramater.
Good catch on spelling, I have updated thanks.
I wasn't sure how to handle the bool / int distinction. They are integer values but treated as booleans ie 0= Off, 1=0n.
I’m guessing there is a general desire to change variables to bool if that is how they are used. Makes sense.
A few pre-review thoughts on this (1) Important to get started on this - thanks @derekwinton for kicking it off (some time ago...) (2) I know a bunch of work has been going on documenting params, which will be on its way into a github form and may supercede this PR. (3) I'd be excited about any creative way that the code could be self-documenting - possibly some pipeline that updates this .md and keeps it in sync, as I imagine it's easy to let these things slide.