Bug #6501
closedDocumentation for Exception#set_backtrace is incorrect
Description
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 mame (Yusuke Endoh) almost 12 years ago
- Status changed from Open to Assigned
- Assignee set to drbrain (Eric Hodel)
Hello drbrain,
Could you treat this?
ko1, tell us if you have any opinion (or objection) about this.
--
Yusuke Endoh mame@tsg.ne.jp
Updated by ko1 (Koichi Sasada) almost 12 years ago
(2012/05/27 19:26), mame (Yusuke Endoh) wrote:
ko1, tell us if you have any opinion (or objection) about this.
I don't have any opinion about it.
--
// SASADA Koichi at atdot dot net
Updated by drbrain (Eric Hodel) almost 12 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]