cta-observatory / ctapipe

Low-level data processing pipeline software for CTAO or similar arrays of Imaging Atmospheric Cherenkov Telescopes
https://ctapipe.readthedocs.org
BSD 3-Clause "New" or "Revised" License
64 stars 268 forks source link

Should we deprecate changed config options? #2521

Open kosack opened 7 months ago

kosack commented 7 months ago

In #2520, I changed a bunch of config option names, which will break existing config files. Maybe before release the next version we should add back in the old options, but with a deprecation warning? (e.g. put them back in, but with an @observe function that issues a more useful error like:

The config option write_images is now write_dl1_images, please update your configuration file

Would this be useful? Or just confusing? It could even simply forward those options to the new version, so old config files would work, but with a warning until the next release.