Documentation for Exception#set_backtrace is incorrect
The documentation for Exception#set_backtrace is incorrect. It currently says that its argument must be an array of strings.
/* * call-seq: * exc.set_backtrace(array) -> array * * Sets the backtrace information associated with <i>exc</i>. The * argument must be an array of <code>String</code> objects in the * format described in <code>Exception#backtrace</code>. */
In fact, it will also accept a single string as an argument, which is a good thing, since it let's me do stuff like "raise SystemCallError, FFI.errno, 'some_function'". Otherwise I would have to use ['some_function'], which would be annoying.
Updated by drbrain (Eric Hodel) about 8 years ago
- Status changed from Assigned to Closed
- % Done changed from 0 to 100
This issue was solved with changeset r35837.
Daniel, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.
- error.c (exc_set_backtrace): Updated documentation to indicate set_backtrace allows a string as well as an array of strings. [ruby-trunk - Bug #6501]