From f8c1ca18c91213c16708d565165c9e7a2420cf85 Mon Sep 17 00:00:00 2001 From: matz Date: Mon, 14 Nov 2005 08:39:34 +0000 Subject: * array.c (rb_ary_first): RDoc update from Daniel Berger . [ruby-core:06577]. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@9534 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- array.c | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'array.c') diff --git a/array.c b/array.c index f16e0a663c..d14a49a716 100644 --- a/array.c +++ b/array.c @@ -715,12 +715,16 @@ rb_ary_at(ary, pos) /* * call-seq: * array.first -> obj or nil - * - * Returns the first element of the array. If the array is empty, - * returns nil. - * + * array.first(n) -> an_array + * + * Returns the first element, or the first +n+ elements, of the array. + * If the array is empty, the first form returns nil, and the + * second form returns an empty array. + * * a = [ "q", "r", "s", "t" ] - * a.first #=> "q" + * a.first #=> "q" + * a.first(1) #=> ["q"] + * a.first(3) #=> ["q", "r", "s"] */ static VALUE -- cgit v1.2.3