Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

distinguish between optional, recommended and required configuration settings #268

Open
trz42 opened this issue May 6, 2024 · 0 comments

Comments

@trz42
Copy link
Contributor

trz42 commented May 6, 2024

The function check_required_cfg_settings(REQUIRED_CONFIG) verifies if all settings listed in the dictionary REQUIRED_CONFIGS are provided in the bot configuration app.cfg. At the moment it can only distinguish between optional settings (those would not be listed in REQUIRED_CONFIG) and required settings (those that are listed in REQUIRED_CONFIG).

There are, however, settings which fall into a third category of recommended settings. The bot will work without them being set, but they are very useful. Because of that (being very useful and not being able to distinguish recommended settings), in #266 they are added to the list of required settings in REQUIRED_CONFIG.

If the check_required_cfg_settings function supports recommended settings, the check at the start of the bot components could make use of that. For example, it could show a warning or hint that some recommended setting is missing.

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

No branches or pull requests

1 participant