You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently it's really hard for users and even developers to know what goes in the config file. Like which parameters are being used and which not.
Hence, we need to define a schema so that the available keys and their meanings can be understood.
In addition, if we can unify especially the common things in the loaders to similar keys, that'd be ideal. One example is the channel list (group names and keys) and aliases that differ in all loaders.
Once we have a schema, which we can define using jsonschema (or others), we can validate everytime during parsing config if it is valid.
Problems I see if we do this: The older config files might become unusable so a way has to be figured on how to work with that. Or maybe we just introduce the newer config file schema in v1.0.0
The text was updated successfully, but these errors were encountered:
We would also like to document which functions make use of which config parameters. Not sure if it's possible to do with pydantic alone but should be looked into.
This is useful for new users to know what is possible to configure
We would also like to document which functions make use of which config parameters. Not sure if it's possible to do with pydantic alone but should be looked into.
This is useful for new users to know what is possible to configure
This is already documented at many places in the docstrings (i.e. as defaults)
Currently it's really hard for users and even developers to know what goes in the config file. Like which parameters are being used and which not.
Hence, we need to define a schema so that the available keys and their meanings can be understood.
In addition, if we can unify especially the common things in the loaders to similar keys, that'd be ideal. One example is the channel list (group names and keys) and aliases that differ in all loaders.
Once we have a schema, which we can define using jsonschema (or others), we can validate everytime during parsing config if it is valid.
Problems I see if we do this: The older config files might become unusable so a way has to be figured on how to work with that. Or maybe we just introduce the newer config file schema in v1.0.0
The text was updated successfully, but these errors were encountered: