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

Inconsistent documentation for ENV prefix #162

Closed
smoyte opened this issue Jan 4, 2017 · 3 comments · Fixed by #246
Closed

Inconsistent documentation for ENV prefix #162

smoyte opened this issue Jan 4, 2017 · 3 comments · Fixed by #246

Comments

@smoyte
Copy link

smoyte commented Jan 4, 2017

I believe these are the correct settings for bash-style env vars:

# Initializes the config gem
Config.setup do |config|
  config.use_env = true
  config.env_prefix = 'SETTINGS'
  config.env_separator = '__'
  config.env_converter = :downcase
  config.env_parse_values = true
end

Note that env_prefix needs to be all uppercase. What is there now is Settings, which doesn't work for me.

Thanks for such a great gem!

@pkuczynski
Copy link
Member

@rdubya what you think?

@pkuczynski pkuczynski added this to the 2.0.1 milestone Jun 28, 2019
@rdubya
Copy link
Contributor

rdubya commented Jul 1, 2019

Looks like we should probably fix the default since the docs already say that the default is in all caps. That might be a breaking change though.

@pkuczynski pkuczynski changed the title Small error in docs Inconsistent documentation for ENV prefix Aug 6, 2019
@pkuczynski
Copy link
Member

Bash variables do not need to be in all upper case. You can easily define them in any case. But you are right, a common practice is to set them all upper case. I just updated the generator by doing all upper case definition - this way we will not affect current users.

Please have a look at #246 and let me know if this is enough in your opinion to close this ticket?

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

Successfully merging a pull request may close this issue.

3 participants