* thread.c: Documentation for Thread#backtrace_locations

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39430 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

2 files changed, 18 insertions, 2 deletions

diff --git a/ChangeLog b/ChangeLog
index 2c4accfdb9..1db177e462 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Sat Feb 23 16:51:00 2013  Zachary Scott  <zachary@zacharyscott.net>
+
+	* thread.c: Documentation for Thread#backtrace_locations
+
 Sat Feb 23 16:05:00 2013  Zachary Scott  <zachary@zacharyscott.net>
 
 	* vm.c: Typo in ObjectSpace::WeakMap overview
diff --git a/thread.c b/thread.c
index b4a3f4cb65..82d4c0d623 100644
--- a/thread.c
+++ b/thread.c
@@ -4833,9 +4833,10 @@ rb_exec_recursive_outer(VALUE (*func) (VALUE, VALUE, int), VALUE obj, VALUE arg)
 
 /*
  *  call-seq:
- *     thr.backtrace    -> array
+ *     thread.backtrace    -> array
+ *
+ *  Returns the current backtrace of the target thread.
  *
- *  Returns the current back trace of the _thr_.
  */
 
 static VALUE
@@ -4844,6 +4845,17 @@ rb_thread_backtrace_m(int argc, VALUE *argv, VALUE thval)
     return vm_thread_backtrace(argc, argv, thval);
 }
 
+/* call-seq:
+ *  thread.backtrace_locations(*args)	-> array or nil
+ *
+ * Returns the execution stack for the target thread---an array containing
+ * backtrace location objects.
+ *
+ * See Thread::Backtrace::Location for more information.
+ *
+ * This method behaves similarly to Kernel#caller_locations except for a
+ * specific thread.
+ */
 static VALUE
 rb_thread_backtrace_locations_m(int argc, VALUE *argv, VALUE thval)
 {