From: "mame (Yusuke Endoh)" <mame@...>
Date: 2012-05-27T19:26:41+09:00
Subject: [ruby-core:45276] [ruby-trunk - Bug #6501][Assigned] Documentation for Exception#set_backtrace is incorrect


Issue #6501 has been updated by mame (Yusuke Endoh).

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>
----------------------------------------
Bug #6501: Documentation for Exception#set_backtrace is incorrect
https://bugs.ruby-lang.org/issues/6501#change-26854

Author: djberg96 (Daniel Berger)
Status: Assigned
Priority: Normal
Assignee: drbrain (Eric Hodel)
Category: 
Target version: 
ruby -v: ruby 1.9.3p194 (2012-04-20 revision 35410) [x86_64-darwin10.8.0]


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.


-- 
http://bugs.ruby-lang.org/