summaryrefslogtreecommitdiff
path: root/trace_point.rb
diff options
context:
space:
mode:
authorVictor Shepelev <zverok.offline@gmail.com>2023-12-14 23:01:48 +0200
committerGitHub <noreply@github.com>2023-12-14 23:01:48 +0200
commit570d7b2c3e2ee39e07548dfe242b684ec794789d (patch)
treeee123eb1d1a8680ee9fd5f7c7a873a120acd833d /trace_point.rb
parentd3deb1b8232a303dd40909e32f939bad3b24a8af (diff)
[DOC] Adjust some new features wording/examples. (#9183)
* Reword Range#overlap? docs last paragraph. * Docs: add explanation about Queue#freeze * Docs: Add :rescue event docs for TracePoint * Docs: Enhance Module#set_temporary_name documentation * Docs: Slightly expand Process::Status deprecations * Fix MatchData#named_captures rendering glitch * Improve Dir.fchdir examples * Adjust Refinement#target docs
Diffstat (limited to 'trace_point.rb')
-rw-r--r--trace_point.rb9
1 files changed, 5 insertions, 4 deletions
diff --git a/trace_point.rb b/trace_point.rb
index dc9c339b6b..e61b4b6802 100644
--- a/trace_point.rb
+++ b/trace_point.rb
@@ -37,6 +37,7 @@
# +:c_call+:: call a C-language routine
# +:c_return+:: return from a C-language routine
# +:raise+:: raise an exception
+# +:rescue+:: rescue an exception
# +:b_call+:: event hook at block entry
# +:b_return+:: event hook at block ending
# +:a_call+:: event hook at all calls (+call+, +b_call+, and +c_call+)
@@ -375,7 +376,7 @@ class TracePoint
# Return the generated binding object from event.
#
- # Note that for +c_call+ and +c_return+ events, the method will return
+ # Note that for +:c_call+ and +:c_return+ events, the method will return
# +nil+, since C methods themselves do not have bindings.
def binding
Primitive.tracepoint_attr_binding
@@ -384,19 +385,19 @@ class TracePoint
# Return the trace object during event
#
# Same as the following, except it returns the correct object (the method
- # receiver) for +c_call+ and +c_return+ events:
+ # receiver) for +:c_call+ and +:c_return+ events:
#
# trace.binding.eval('self')
def self
Primitive.tracepoint_attr_self
end
- # Return value from +:return+, +c_return+, and +b_return+ event
+ # Return value from +:return+, +:c_return+, and +:b_return+ event
def return_value
Primitive.tracepoint_attr_return_value
end
- # Value from exception raised on the +:raise+ event
+ # Value from exception raised on the +:raise+ event, or rescued on the +:rescue+ event.
def raised_exception
Primitive.tracepoint_attr_raised_exception
end