diff options
| author | Sean Griffin <sean@seantheprogrammer.com> | 2017-07-17 10:53:59 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-07-17 10:53:59 -0400 |
| commit | 828b05f5f9f8decf55170ea75bfdc6d37787993d (patch) | |
| tree | 5fc633a91dd919f69ab8dd5d26af149d3cb88e4d | |
| parent | 8e06f09875d7c935c69f137c3b992a35b782daa0 (diff) | |
| parent | 5fa6563f09cd1ee84860364195249a9f7faa26a7 (diff) | |
| download | rails-828b05f5f9f8decf55170ea75bfdc6d37787993d.tar.gz rails-828b05f5f9f8decf55170ea75bfdc6d37787993d.tar.bz2 rails-828b05f5f9f8decf55170ea75bfdc6d37787993d.zip | |
Merge pull request #29758 from glaucocustodio/patch-1 [ci skip]
Add documentation for class_attribute default option
| -rw-r--r-- | activesupport/lib/active_support/core_ext/class/attribute.rb | 10 | ||||
| -rw-r--r-- | guides/source/active_support_core_extensions.md | 3 |
2 files changed, 11 insertions, 2 deletions
diff --git a/activesupport/lib/active_support/core_ext/class/attribute.rb b/activesupport/lib/active_support/core_ext/class/attribute.rb index a72dbc7bf0..e5a52db36a 100644 --- a/activesupport/lib/active_support/core_ext/class/attribute.rb +++ b/activesupport/lib/active_support/core_ext/class/attribute.rb @@ -8,6 +8,16 @@ class Class # Declare a class-level attribute whose value is inheritable by subclasses. # Subclasses can change their own value and it will not impact parent class. # + # ==== Options + # + # * <tt>:instance_reader</tt> - Sets the instance reader method (defaults to true). + # * <tt>:instance_writer</tt> - Sets the instance writer method (defaults to true). + # * <tt>:instance_accessor</tt> - Sets both instance methods (defaults to true). + # * <tt>:instance_predicate</tt> - Sets a predicate method (defaults to true). + # * <tt>:default</tt> - Sets a default value for the attribute (defaults to nil). + # + # ==== Examples + # # class Base # class_attribute :setting # end diff --git a/guides/source/active_support_core_extensions.md b/guides/source/active_support_core_extensions.md index 23f53ac084..4c37f6aba9 100644 --- a/guides/source/active_support_core_extensions.md +++ b/guides/source/active_support_core_extensions.md @@ -927,8 +927,7 @@ The generation of the writer instance method can be prevented by setting the opt ```ruby module ActiveRecord class Base - class_attribute :table_name_prefix, instance_writer: false - self.table_name_prefix = "" + class_attribute :table_name_prefix, instance_writer: false, default: "my" end end ``` |