Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Implement a version control of the settings file #321

Open
tsufz opened this issue Feb 8, 2023 · 2 comments
Open

Implement a version control of the settings file #321

tsufz opened this issue Feb 8, 2023 · 2 comments

Comments

@tsufz
Copy link
Member

tsufz commented Feb 8, 2023

I sometimes observe that the users use legacy settings files. I suggest implementing a version control in the read settings function. I did this in my MZquant package. The version in which the changes are made is hard-coded in the current settings file and the check function. What do you think about?

@meowcat
Copy link

meowcat commented Feb 9, 2023

What is your suggested action for legacy settings?

  1. stop("please update your settings to version $newestversion")
  2. keep supporting them?

@tsufz
Copy link
Member Author

tsufz commented Feb 9, 2023

This is in the terms of backward compatibility. This maybe depends on the extent of the changes made. If we do something substantial new, I am against supporting of legacy structures to keep efforts and code slim. In case of minor changes, it may be worth to think about a support of legacy settings without new functionalities. Something like:

  1. stop("please update your settings to version $newestversion") in case of major changes
  2. warning("Settings was updated to map new functions. The version of your settings is still supported. To use the new function update to $newestversion, please").

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

2 participants