From 914efd0b60acc061b161faa4ebb8bce528793384 Mon Sep 17 00:00:00 2001
From: marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 17 May 2010 21:07:46 +0000
Subject: * proc.c (proc_lambda, unnamed_parameters): Small documentation
 fixes.

* re.c: ditto

* string.c: ditto

* time.c: ditto

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27867 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 proc.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'proc.c')

diff --git a/proc.c b/proc.c
index 9babd5da4b..856c3ee9bb 100644
--- a/proc.c
+++ b/proc.c
@@ -528,10 +528,10 @@ proc_lambda(void)
 
 /*
  *  call-seq:
- *     prc === obj   -> obj
+ *     prc === obj   -> result_of_proc
  *
  *  Invokes the block, with <i>obj</i> as the block's parameter.  It is
- *  to allow a proc object to be a target of when clause in the case statement.
+ *  to allow a proc object to be a target of +when+ clause in the case statement.
  */
 
 static VALUE
@@ -728,7 +728,10 @@ unnamed_parameters(int arity)
  * call-seq:
  *    proc.parameters  -> array
  *
- * returns the parameter information of this proc
+ * returns the parameter information of this proc.
+ *
+ *    prc = lambda{|x, y=42, *rest|}
+ *    prc.parameters  #=> [[:req, :x], [:opt, :y], [:rest, :rest]]
  */
 
 static VALUE
-- 
cgit v1.2.3