Skip to content

Commit

Permalink
Merge pull request #29 from rurema/update-generated-documents
Browse files Browse the repository at this point in the history
Update generated documents
  • Loading branch information
github-actions[bot] authored Nov 17, 2024
2 parents 75682e9 + 59bf4e2 commit 44e39e4
Show file tree
Hide file tree
Showing 402 changed files with 1,178 additions and 778 deletions.
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.append_features._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=append_features
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1624
source_location=refm/api/src/_builtin/Module:1644

--- append_features(module_or_class) -> self

Expand Down
20 changes: 20 additions & 0 deletions db/db-3.0/method/-module/i.class_eval._builtin
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ source_location=refm/api/src/_builtin/Module:977

ただし、ローカル変数は module_eval/class_eval の外側のスコープと共有します。

定数とクラス変数のスコープは、文字列が与えられた場合とブロックが与えられた場合で挙動が異なります。
文字列が与えられた場合には、定数とクラス変数のスコープは自身のモジュール定義式内と同じスコープになります。
ブロックが与えられた場合には、定数とクラス変数のスコープはブロックの外側のスコープになります。

Expand All @@ -41,5 +42,24 @@ C.class_eval %Q{
p C.new.m #=> [:m, 1]
//}

//emlist[定数のスコープが異なる例][ruby]{
class C
end

# ブロックが渡された場合は、ブロックの外側のスコープになる。
# つまり、この場合はトップレベルに定数 X を定義する。
C.class_eval { X = 1 }

# 文字列が渡された場合は、モジュール定義式内と同じスコープになる。つまり、この場合は
# class C
# X = 2
# end
# と書いたのと同じ意味になる。
C.class_eval 'X = 2'

p X #=> 1
p C::X #=> 2
//}

@see [[m:BasicObject#instance_eval]], [[m:Module.new]], [[m:Kernel.#eval]]

2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.class_exec._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=class_exec,module_exec
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1021
source_location=refm/api/src/_builtin/Module:1041

--- module_exec(*args) {|*vars| ... } -> object
--- class_exec(*args) {|*vars| ... } -> object
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=class_variable_defined?
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1507
source_location=refm/api/src/_builtin/Module:1527

--- class_variable_defined?(name) -> bool

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.class_variable_get._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=class_variable_get
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1525
source_location=refm/api/src/_builtin/Module:1545

--- class_variable_get(name) -> object

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.class_variable_set._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=class_variable_set
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1546
source_location=refm/api/src/_builtin/Module:1566

--- class_variable_set(name, val) -> object

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.extend_object._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=extend_object
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1651
source_location=refm/api/src/_builtin/Module:1671

--- extend_object(obj) -> object

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.extended._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=extended
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1677
source_location=refm/api/src/_builtin/Module:1697

--- extended(obj) -> ()

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.included._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=included
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1703
source_location=refm/api/src/_builtin/Module:1723

--- included(class_or_module) -> ()

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.inspect._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=inspect,name,to_s
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1057
source_location=refm/api/src/_builtin/Module:1077

--- name -> String | nil
--- to_s -> String
Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.instance_methods._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=instance_methods
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1108
source_location=refm/api/src/_builtin/Module:1128

--- instance_methods(inherited_too = true) -> [Symbol]

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.method_added._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=method_added
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1740
source_location=refm/api/src/_builtin/Module:1760

--- method_added(name) -> ()

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.method_removed._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=method_removed
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1769
source_location=refm/api/src/_builtin/Module:1789

--- method_removed(name) -> ()

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.method_undefined._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=method_undefined
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1799
source_location=refm/api/src/_builtin/Module:1819

--- method_undefined(name) -> ()

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.module_function._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=module_function
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1837
source_location=refm/api/src/_builtin/Module:1857

--- module_function() -> nil
--- module_function(name) -> String | Symbol
Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.prepend_features._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=prepend_features
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:2142
source_location=refm/api/src/_builtin/Module:2162

--- prepend_features(mod) -> self
[[m:Module#prepend]] から呼び出されるメソッドで、
Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.prepended._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=prepended
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:2181
source_location=refm/api/src/_builtin/Module:2201

--- prepended(class_or_module) -> ()

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.private._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=private
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1910
source_location=refm/api/src/_builtin/Module:1930

--- private() -> nil
--- private(name) -> String | Symbol
Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.private_class_method._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=private_class_method
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1259
source_location=refm/api/src/_builtin/Module:1279

--- private_class_method(*name) -> self
--- private_class_method(names) -> self
Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.private_constant._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=private_constant
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1284
source_location=refm/api/src/_builtin/Module:1304

--- private_constant(*name) -> self

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=private_instance_methods
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1215
source_location=refm/api/src/_builtin/Module:1235

--- private_instance_methods(inherited_too = true) -> [Symbol]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=private_method_defined?
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1385
source_location=refm/api/src/_builtin/Module:1405

--- private_method_defined?(name, inherit=true) -> bool

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.protected._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=protected
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1948
source_location=refm/api/src/_builtin/Module:1968

--- protected() -> nil
--- protected(name) -> String | Symbol
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=protected_instance_methods
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1245
source_location=refm/api/src/_builtin/Module:1265

--- protected_instance_methods(inherited_too = true) -> [Symbol]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=protected_method_defined?
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1426
source_location=refm/api/src/_builtin/Module:1446

--- protected_method_defined?(name, inherit=true) -> bool

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.public._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=public
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1978
source_location=refm/api/src/_builtin/Module:1998

--- public() -> nil
--- public(name) -> String | Symbol
Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.public_class_method._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=public_class_method
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1317
source_location=refm/api/src/_builtin/Module:1337

--- public_class_method(*name) -> self
--- public_class_method(names) -> self
Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.public_constant._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=public_constant
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1345
source_location=refm/api/src/_builtin/Module:1365

--- public_constant(*name) -> self

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.public_instance_method._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=public_instance_method
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1182
source_location=refm/api/src/_builtin/Module:1202

--- public_instance_method(name) -> UnboundMethod

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=public_instance_methods
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1200
source_location=refm/api/src/_builtin/Module:1220

--- public_instance_methods(inherited_too = true) -> [Symbol]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=public_method_defined?
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1467
source_location=refm/api/src/_builtin/Module:1487

--- public_method_defined?(name, inherit=true) -> bool

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.refine._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=refine
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:2072
source_location=refm/api/src/_builtin/Module:2092

--- refine(klass) { ... } -> Module

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.remove_class_variable._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=remove_class_variable
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1571
source_location=refm/api/src/_builtin/Module:1591

--- remove_class_variable(name) -> object

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.remove_const._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=remove_const
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:2039
source_location=refm/api/src/_builtin/Module:2059

--- remove_const(name) -> object

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.ruby2_keywords._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=ruby2_keywords
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:2204
source_location=refm/api/src/_builtin/Module:2224

--- ruby2_keywords(method_name, ...) -> nil

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.singleton_class=3f._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=singleton_class?
visibility=public
kind=defined
source_location=refm/api/src/_builtin/Module:1595
source_location=refm/api/src/_builtin/Module:1615

--- singleton_class? -> bool

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.0/method/-module/i.using._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=using
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:2237
source_location=refm/api/src/_builtin/Module:2257

--- using(module) -> self

Expand Down
2 changes: 1 addition & 1 deletion db/db-3.1/method/-module/i.append_features._builtin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
names=append_features
visibility=private
kind=defined
source_location=refm/api/src/_builtin/Module:1624
source_location=refm/api/src/_builtin/Module:1644

--- append_features(module_or_class) -> self

Expand Down
20 changes: 20 additions & 0 deletions db/db-3.1/method/-module/i.class_eval._builtin
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ source_location=refm/api/src/_builtin/Module:977

ただし、ローカル変数は module_eval/class_eval の外側のスコープと共有します。

定数とクラス変数のスコープは、文字列が与えられた場合とブロックが与えられた場合で挙動が異なります。
文字列が与えられた場合には、定数とクラス変数のスコープは自身のモジュール定義式内と同じスコープになります。
ブロックが与えられた場合には、定数とクラス変数のスコープはブロックの外側のスコープになります。

Expand All @@ -41,5 +42,24 @@ C.class_eval %Q{
p C.new.m #=> [:m, 1]
//}

//emlist[定数のスコープが異なる例][ruby]{
class C
end

# ブロックが渡された場合は、ブロックの外側のスコープになる。
# つまり、この場合はトップレベルに定数 X を定義する。
C.class_eval { X = 1 }

# 文字列が渡された場合は、モジュール定義式内と同じスコープになる。つまり、この場合は
# class C
# X = 2
# end
# と書いたのと同じ意味になる。
C.class_eval 'X = 2'

p X #=> 1
p C::X #=> 2
//}

@see [[m:BasicObject#instance_eval]], [[m:Module.new]], [[m:Kernel.#eval]]

Loading

0 comments on commit 44e39e4

Please sign in to comment.