search

UCL / TLOmodel

Epidemiology modelling framework for the Thanzi la Onse project
https://www.tlomodel.org/
MIT License
13 stars 5 forks source link

Inform users that some ResourceFiles (those for the HealthSystem) should not be edited directly. #1385

Open EvaJanouskova opened 5 months ago

EvaJanouskova commented 5 months ago

Could we have a test for Resource Files generated by a script (ie, not created manually) to assure no one has manually made a change in that RF?

I had no idea a RF was generated by a script, so I made all the changes manually, it was even merged to master creating so a bit mess. But if it would cause a test to fail, we might have known.

EvaJanouskova commented 5 months ago

We could perhaps also change the names of such RFs so that the names contain a notation indicating that these files are generated by a script, so that it is clear at a glance (e.g. prefix _, or suffix _gen).

tbhallett commented 5 months ago

It's a good idea. We could possibly add a note to the 'README.md' about the ResourceFiles being 'read only' (unless you're generating them from a script), or we could this in a 'README.txt' file in resources/healthsystem