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

Refine Config Files #2

Open
QuentinTorg opened this issue Sep 6, 2020 · 0 comments · May be fixed by #1
Open

Refine Config Files #2

QuentinTorg opened this issue Sep 6, 2020 · 0 comments · May be fixed by #1
Labels
enhancement New feature or request

Comments

@QuentinTorg
Copy link
Owner

QuentinTorg commented Sep 6, 2020

Goals

  • Config files should use some file type that will allow a nested structure, similar to the class structure of the keyboard
    • This could be dictionaries and lists only, that are converted to yaml, or it could be a more complex config class that has serialize/deserailize functions built in
  • In a perfect world, a user could request the default config of a keyboard, and it would return the entire config file for all parts of the keyboard. The config would have comments that describe what each parameter controls. I think this will require a config class

Requirements

  • Each class has a function that allows the user to request the default config.
  • Any tunable parameter in a class should be configurable with the config file
  • A class should be able to accept an incomplete config, and will pull missing values from the default config
    • The user only needs to specify values that they want to change
  • User only needs to pass a single config into each class.
    • ex. Assembly config should have the config for each part nested within it
@QuentinTorg QuentinTorg linked a pull request Sep 6, 2020 that will close this issue
@QuentinTorg QuentinTorg added the enhancement New feature or request label Sep 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant