aboutsummaryrefslogtreecommitdiffstats
path: root/railties
diff options
context:
space:
mode:
authoryuuji.yaginuma <yuuji.yaginuma@gmail.com>2017-11-19 14:42:45 +0900
committeryuuji.yaginuma <yuuji.yaginuma@gmail.com>2017-11-19 14:42:45 +0900
commit83cb0fc6326b308322e35b211bac31c73b346b73 (patch)
tree875df9e49d652c8c0bfdba84afa0745457c1d28e /railties
parent067fc779c4560fff4812614a2f78f9248f3e55f8 (diff)
downloadrails-83cb0fc6326b308322e35b211bac31c73b346b73.tar.gz
rails-83cb0fc6326b308322e35b211bac31c73b346b73.tar.bz2
rails-83cb0fc6326b308322e35b211bac31c73b346b73.zip
Fix formatting of `credentials` and `encrypted` [ci skip]
Diffstat (limited to 'railties')
-rw-r--r--railties/lib/rails/application.rb16
1 files changed, 8 insertions, 8 deletions
diff --git a/railties/lib/rails/application.rb b/railties/lib/rails/application.rb
index df266fbfce..b1429df18b 100644
--- a/railties/lib/rails/application.rb
+++ b/railties/lib/rails/application.rb
@@ -429,23 +429,23 @@ module Rails
end
end
- # Decrypts the credentials hash as kept in `config/credentials.yml.enc`. This file is encrypted with
- # the Rails master key, which is either taken from ENV["RAILS_MASTER_KEY"] or from loading
- # `config/master.key`.
+ # Decrypts the credentials hash as kept in +config/credentials.yml.enc+. This file is encrypted with
+ # the Rails master key, which is either taken from <tt>ENV["RAILS_MASTER_KEY"]</tt> or from loading
+ # +config/master.key+.
def credentials
@credentials ||= encrypted("config/credentials.yml.enc")
end
# Shorthand to decrypt any encrypted configurations or files.
#
- # For any file added with `bin/rails encrypted:edit` call `read` to decrypt
+ # For any file added with <tt>bin/rails encrypted:edit</tt> call +read+ to decrypt
# the file with the master key.
- # The master key is either stored in `config/master.key` or `ENV["RAILS_MASTER_KEY"]`.
+ # The master key is either stored in +config/master.key+ or <tt>ENV["RAILS_MASTER_KEY"]</tt>.
#
# Rails.application.encrypted("config/mystery_man.txt.enc").read
# # => "We've met before, haven't we?"
#
- # It's also possible to interpret encrypted YAML files with `config`.
+ # It's also possible to interpret encrypted YAML files with +config+.
#
# Rails.application.encrypted("config/credentials.yml.enc").config
# # => { next_guys_line: "I don't think so. Where was it you think we met?" }
@@ -456,11 +456,11 @@ module Rails
# # => "I don't think so. Where was it you think we met?"
#
# The files or configs can also be encrypted with a custom key. To decrypt with
- # a key in the `ENV`, use:
+ # a key in the +ENV+, use:
#
# Rails.application.encrypted("config/special_tokens.yml.enc", env_key: "SPECIAL_TOKENS")
#
- # Or to decrypt with a file, that should be version control ignored, relative to `Rails.root`:
+ # Or to decrypt with a file, that should be version control ignored, relative to +Rails.root+:
#
# Rails.application.encrypted("config/special_tokens.yml.enc", key_path: "config/special_tokens.key")
def encrypted(path, key_path: "config/master.key", env_key: "RAILS_MASTER_KEY")