1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Clarify documentation for Module#included_modules and Module#included?

[DOC] [ci skip] [Bug #8841]
This commit is contained in:
Marc-Andre Lafortune 2020-01-16 13:28:37 -06:00
parent 95301378fc
commit 8ab11096ef

15
class.c
View file

@ -1022,17 +1022,22 @@ rb_prepend_module(VALUE klass, VALUE module)
* call-seq:
* mod.included_modules -> array
*
* Returns the list of modules included in <i>mod</i>.
* Returns the list of modules included or prepended in <i>mod</i>
* or one of <i>mod</i>'s ancestors.
*
* module Sub
* end
*
* module Mixin
* prepend Sub
* end
*
* module Outer
* include Mixin
* end
*
* Mixin.included_modules #=> []
* Outer.included_modules #=> [Mixin]
* Mixin.included_modules #=> [Sub]
* Outer.included_modules #=> [Sub, Mixin]
*/
VALUE
@ -1056,8 +1061,8 @@ rb_mod_included_modules(VALUE mod)
* call-seq:
* mod.include?(module) -> true or false
*
* Returns <code>true</code> if <i>module</i> is included in
* <i>mod</i> or one of <i>mod</i>'s ancestors.
* Returns <code>true</code> if <i>module</i> is included
* or prepended in <i>mod</i> or one of <i>mod</i>'s ancestors.
*
* module A
* end