Add an example to base_label API

fxn · byroot · commit 4235bc295b1a · 2024-03-25T14:13:05.000+01:00
diff --git a/vm_backtrace.c b/vm_backtrace.c
@@ -315,9 +315,10 @@ location_base_label(rb_backtrace_location_t *loc)
 }
 
 /*
- * Returns the base label of this frame.
+ * Returns the label of this frame without decoration.
  *
- * Usually same as #label, without decoration.
+ * For example, if the label is `foo`, this method returns `foo`, same, but if
+ * the label is +rescue in foo+, this method returns just +foo+.
  */
 static VALUE
 location_base_label_m(VALUE self)

Original file line number	Diff line number	Diff line change
`@@ -315,9 +315,10 @@ location_base_label(rb_backtrace_location_t *loc)`
`315`	`315`	`}`
`316`	`316`
`317`	`317`	`/*`
`318`		`- * Returns the base label of this frame.`
	`318`	`+ * Returns the label of this frame without decoration.`
`319`	`319`	`*`
`320`		`- * Usually same as #label, without decoration.`
	`320`	+ * For example, if the label is `foo`, this method returns `foo`, same, but if
	`321`	`+ * the label is +rescue in foo+, this method returns just +foo+.`
`321`	`322`	`*/`
`322`	`323`	`static VALUE`
`323`	`324`	`location_base_label_m(VALUE self)`