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

Encourage arity argument in Proc#curry documentation for procs with variable arguments

This uses similar language to that used in Method#curry.
This commit is contained in:
Jeremy Evans 2022-03-17 20:34:13 -07:00
parent 2fdfd499db
commit 634e0a97eb

4
proc.c
View file

@ -3569,6 +3569,10 @@ curry(RB_BLOCK_CALL_FUNC_ARGLIST(_, args))
* proc and returns the result. Otherwise, returns another curried proc that
* takes the rest of arguments.
*
* The optional <i>arity</i> argument should be supplied when currying procs with
* variable arguments to determine how many arguments are needed before the proc is
* called.
*
* b = proc {|x, y, z| (x||0) + (y||0) + (z||0) }
* p b.curry[1][2][3] #=> 6
* p b.curry[1, 2][3, 4] #=> 6