Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Update documentation for Rails::Application#env_config #7070

Merged
merged 1 commit into from

4 participants

@jmazzi

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

@rafaelfranca

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
Owner

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

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

@fxn
Owner

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

@vijaydev
Collaborator

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
Owner

@vijaydev perfect!

@jmazzi jmazzi referenced this pull request from a commit
Commit has since been removed from the repository and is no longer available.
@jmazzi

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

@jmazzi jmazzi referenced this pull request from a commit
Commit has since been removed from the repository and is no longer available.
@jmazzi jmazzi referenced this pull request from a commit
Commit has since been removed from the repository and is no longer available.
@jmazzi jmazzi referenced this pull request from a commit in jmazzi/rails
@jmazzi jmazzi Restoring documentation for env_config per #7070 083ddec
@rafaelfranca rafaelfranca merged commit 3e01a2a into rails:3-2-stable
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jul 16, 2012
  1. @jmazzi
This page is out of date. Refresh to see the latest.
Showing with 6 additions and 3 deletions.
  1. +6 −3 railties/lib/rails/application.rb
View
9 railties/lib/rails/application.rb
@@ -157,9 +157,12 @@ def load_console(app=self)
# Rails.application.env_config stores some of the Rails initial environment parameters.
# Currently stores:
#
- # * action_dispatch.parameter_filter" => config.filter_parameters,
- # * action_dispatch.secret_token" => config.secret_token,
- # * action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions
+ # * "action_dispatch.parameter_filter" => config.filter_parameters,
+ # * "action_dispatch.secret_token" => config.secret_token,
+ # * "action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions,
+ # * "action_dispatch.show_detailed_exceptions" => config.consider_all_requests_local,
+ # * "action_dispatch.logger" => Rails.logger,
+ # * "action_dispatch.backtrace_cleaner" => Rails.backtrace_cleaner
#
# These parameters will be used by middlewares and engines to configure themselves.
#
Something went wrong with that request. Please try again.