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

Document difference between Thread::Backtrace::Location#{,absolute_}path

They are usually the same, except for locations in the main script.
This commit is contained in:
Jeremy Evans 2020-09-23 15:52:54 -07:00
parent 502c3ff02a
commit fae135c5b3

View file

@ -281,7 +281,9 @@ location_path(rb_backtrace_location_t *loc)
}
/*
* Returns the file name of this frame.
* Returns the file name of this frame. This will generally be an absolute
* path, unless the frame is in the main script, in which case it will be the
* script location passed on the command line.
*
* For example, using +caller_locations.rb+ from Thread::Backtrace::Location
*
@ -315,7 +317,8 @@ location_realpath(rb_backtrace_location_t *loc)
/*
* Returns the full file path of this frame.
*
* Same as #path, but includes the absolute path.
* Same as #path, except that it will return absolute path
* even if the frame is in the main script.
*/
static VALUE
location_absolute_path_m(VALUE self)