Update section and key names in config files for clarity and code usage #101
Labels
convention
Repository coding and documentation standards
documentation
Improvements or additions to documentation
enhancement
New feature or request
help wanted
Extra attention is needed
question
Further information is requested
The current section and key names in used by a configuration file are not consistent with each other or necessarily in line with how the values are used in production. Several updates should be performed to clarify usage.
Here are some ideas for the default_config.ini file:
a. the parser, now DataSource, should be renamed and perhaps put into its own section
b. the files should go into a [FILES] section
c. the plugins should go into a [PLUGINS] section
The default_config.ini currently serves as the example that user .ini files should follow. If that usage continues it should include everything, even all optional sections/keys. It may perhaps be better to create a "not for actual use" example for documentation on how to create an OnAIR config file. That example config could either be in addition to or replace the default_config.ini as the template for user's config files.
The text was updated successfully, but these errors were encountered: