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

update lambda? doc.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14713 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
akr 2007-12-26 03:49:10 +00:00
parent 8ffd1eb2a4
commit a3f722abef

87
proc.c
View file

@ -111,33 +111,102 @@ proc_clone(VALUE self)
* call-seq:
* prc.lambda? => true or false
*
* Returns true for a Proc object which argument check is rigid.
* Returns true for a Proc object which argument handling is rigid.
* Such procs are typically generated by lambda.
*
* lambda {}.lambda? => true
* lambda {|a,b| [a,b]}.call(1,2,3) => ArgumentError
* A Proc object generated by proc ignore extra arguments.
*
* proc {|a,b| [a,b] }.call(1,2,3) => [1,2]
*
* It provides nil for lacked arguments.
*
* proc {|a,b| [a,b] }.call(1) => [1,nil]
*
* It expand single-array argument.
*
* proc {|a,b| [a,b] }.call([1,2]) => [1,2]
*
* A Proc object generated by lambda doesn't have such tricks.
*
* lambda {|a,b| [a,b] }.call(1,2,3) => ArgumentError
* lambda {|a,b| [a,b] }.call(1) => ArgumentError
* lambda {|a,b| [a,b] }.call([1,2]) => ArgumentError
*
* Proc#lambda? is a predicate for the tricks.
* It returns true if no tricks.
*
* lambda {}.lambda? => true
* proc {}.lambda? => false
* proc {|a,b| [a,b]}.call(1,2,3) => [1,2]
*
* Proc.new is same as proc.
*
* Proc.new {}.lambda? => false
*
* lambda, proc and Proc.new preserves the tricks of
* a Proc object given by & argument.
*
* lambda(&lambda {}).lambda? => true
* proc(&lambda {}).lambda? => true
* Proc.new(&lambda {}).lambda? => true
*
* lambda(&proc {}).lambda? => false
* proc(&proc {}).lambda? => false
* Proc.new(&proc {}).lambda? => false
*
* A Proc object generated by & argument has the tricks
*
* def n(&b) b.lambda? end
* n {} => false
*
* The & argument preserves the tricks if a Proc object is given
* by & argument.
*
* n(&lambda {}) => true
* n(&proc {}) => false
* n(&Proc.new {}) => false
*
* A Proc object converted from a method has no tricks.
*
* def m() end
* method(:m).to_proc.lambda? => true
*
* def n(&b) b.lambda? end
* n {} => false
* n(&proc {}) => false
* n(&Proc.new {}) => false
* n(&lambda {}) => true
* n(&method(:m)) => true
* n(&method(:m)).to_proc => true
*
* define_method is treated same as method definition.
* The defined method has no tricks.
*
* class C
* define_method(:d) {}
* end
* C.new.e(1,2) => ArgumentError
* C.new.method(:d).to_proc.lambda? => true
*
* define_method always defines a method without the tricks,
* even if a non-lambda Proc object is given.
* This is only the exception which the tricks is changed.
*
* class C
* define_method(:e, &proc {})
* end
* C.new.e(1,2) => ArgumentError
* C.new.method(:e).to_proc.lambda? => true
*
* This exception is for a wrapper of define_method.
* It eases defining a method defining method which defines a usual method which has no tricks.
*
* class << C
* def def2(name, &body)
* define_method(name, &body)
* end
* end
* class C
* def2(:f) {}
* end
* C.new.f(1,2) => ArgumentError
*
* The wrapper, def2, defines a method which has no tricks.
*
*/
static VALUE