kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Fix the docs for Module#parents and related methods in guides [ci skip]

Browse source 
- Followup of https://github.com/rails/rails/pull/34051
This commit is contained in:
Prathamesh Sonpatki 2018-10-03 21:44:39 +05:30
parent b2bc4369a3
commit 92be3848f9
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
guides/source/active_support_core_extensions.md
View file

@ -590,9 +590,9 @@ NOTE: Defined in `active_support/core_ext/module/attribute_accessors.rb`.
### Parents ### Parents
#### `parent` #### `module_parent`
The `parent` method on a nested named module returns the module that contains its corresponding constant: The `module_parent` method on a nested named module returns the module that contains its corresponding constant:
```ruby ```ruby
module X module X
@ -603,19 +603,19 @@ module X
end end
M = X::Y::Z M = X::Y::Z
X::Y::Z.parent # => X::Y X::Y::Z.module_parent # => X::Y
M.parent # => X::Y M.module_parent # => X::Y
``` ```
If the module is anonymous or belongs to the top-level, `parent` returns `Object`. If the module is anonymous or belongs to the top-level, `module_parent` returns `Object`.
WARNING: Note that in that case `parent_name` returns `nil`. WARNING: Note that in that case `module_parent_name` returns `nil`.
NOTE: Defined in `active_support/core_ext/module/introspection.rb`. NOTE: Defined in `active_support/core_ext/module/introspection.rb`.
#### `parent_name` #### `module_parent_name`
The `parent_name` method on a nested named module returns the fully qualified name of the module that contains its corresponding constant: The `module_parent_name` method on a nested named module returns the fully qualified name of the module that contains its corresponding constant:
```ruby ```ruby
module X module X
@ -626,19 +626,19 @@ module X
end end
M = X::Y::Z M = X::Y::Z
X::Y::Z.parent_name # => "X::Y" X::Y::Z.module_parent_name # => "X::Y"
M.parent_name # => "X::Y" M.module_parent_name # => "X::Y"
``` ```
For top-level or anonymous modules `parent_name` returns `nil`. For top-level or anonymous modules `module_parent_name` returns `nil`.
WARNING: Note that in that case `parent` returns `Object`. WARNING: Note that in that case `module_parent` returns `Object`.
NOTE: Defined in `active_support/core_ext/module/introspection.rb`. NOTE: Defined in `active_support/core_ext/module/introspection.rb`.
#### `parents` #### `module_parents`
The method `parents` calls `parent` on the receiver and upwards until `Object` is reached. The chain is returned in an array, from bottom to top: The method `module_parents` calls `module_parent` on the receiver and upwards until `Object` is reached. The chain is returned in an array, from bottom to top:
```ruby ```ruby
module X module X
@ -649,8 +649,8 @@ module X
end end
M = X::Y::Z M = X::Y::Z
X::Y::Z.parents # => [X::Y, X, Object] X::Y::Z.module_parents # => [X::Y, X, Object]
M.parents # => [X::Y, X, Object] M.module_parents # => [X::Y, X, Object]
``` ```
NOTE: Defined in `active_support/core_ext/module/introspection.rb`. NOTE: Defined in `active_support/core_ext/module/introspection.rb`.