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

improve Pry::LastException docs.

This commit is contained in:
Robert Gleeson 2014-03-17 11:27:43 +01:00
parent 2332217547
commit 1e6333cba0

View file

@ -1,7 +1,12 @@
# LastException is a proxy used to add functionality to the `last_exception`
# attribute of Pry instances.
#
# {Pry::LastException} is a proxy class who wraps an Exception object for
# {Pry#last_exception}. it extends the exception object with methods that
# help pry commands be useful.
#
# the original exception object is not modified and method calls are forwarded
# to the wrapped exception object.
#
class Pry::LastException < BasicObject
attr_reader :file, :line
attr_accessor :bt_index
def initialize(e)
@ -22,6 +27,25 @@ class Pry::LastException < BasicObject
@e.respond_to?(name)
end
#
# @return [String]
# returns the path to a file for the current backtrace. see {#bt_index}.
#
def file
@file
end
#
# @return [Fixnum]
# returns the line for the current backtrace. see {#bt_index}.
#
def line
@line
end
# @return [Exception]
# returns the wrapped exception
#
def wrapped_exception
@e
end