Update documentation for Rails::Application#env_config #7070

Merged
merged 1 commit into from Aug 1, 2012

4 participants

@jmazzi

The documentation for Rails::Application#env_config was incorrect and missing some information. This pull request fixes it.

@rafaelfranca
Ruby on Rails member

I think we can remove these information as we did at master.

https://github.com/rails/rails/blob/master/railties/lib/rails/application.rb#L103-104

If they want to know what are configurations they can see with the "view source" link at the API page.

WDYT?

cc/ @fxn @vijaydev

@jmazzi

That sounds reasonable to me. Let me know if that's what you want me to do.

@fxn
Ruby on Rails member

If these keys are public interface, I think they should be documented normally. People should not need to inspect the source code IMO. Why were they removed from master?

@rafaelfranca
Ruby on Rails member

I don't know. If we are going to document it, we need to do in master too.

@fxn
Ruby on Rails member

Great, @jmazzi would you volunteer a patch for master?

@vijaydev
Ruby on Rails member

I was the one who removed them in master here. Back then, the doc didn't match the actual list of configs. My thinking at the time was that it's hard to keep the list in sync, unless people do it diligently.

But yeah, I agree with @fxn that we should document it properly.

@jmazzi
@fxn
Ruby on Rails member

@vijaydev perfect!

@jmazzi

Master has been updated. This can also be pulled unless further change is needed.

@jmazzi jmazzi added a commit to jmazzi/rails that referenced this pull request Aug 1, 2012
@jmazzi jmazzi Restoring documentation for env_config per #7070 083ddec
@rafaelfranca rafaelfranca merged commit 3e01a2a into rails:3-2-stable Aug 1, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment