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

Defaults should not be set again in the configuration #217

Open
lkiesow opened this issue Mar 4, 2020 · 1 comment
Open

Defaults should not be set again in the configuration #217

lkiesow opened this issue Mar 4, 2020 · 1 comment

Comments

@lkiesow
Copy link
Collaborator

lkiesow commented Mar 4, 2020

If a configuration has a default value, it's good practice to have it commented out and not set again so that users can easily identify which options were set and which werent. Right now, we don't do that:

# Number of parallel workers preprocessing the data
# Default: 1
workers: 1

This should look like

# Number of parallel workers preprocessing the data 
# Default: 1 
#workers: 1 
@shaardie
Copy link
Contributor

We could also remove the defaults from the code and only distribute a configuration file with reasonable defaults set. Then all values are in one place. Currently defaults are in the code AND described in the configuration file which is more error prone.

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

No branches or pull requests

2 participants