summaryrefslogtreecommitdiff
path: root/doc/syntax/methods.rdoc
AgeCommit message (Collapse)Author
2021-12-30Add support for anonymous rest and keyword rest argument forwardingJeremy Evans
This allows for the following syntax: ```ruby def foo(*) bar(*) end def baz(**) quux(**) end ``` This is a natural addition after the introduction of anonymous block forwarding. Anonymous rest and keyword rest arguments were already supported in method parameters, this just allows them to be used as arguments to other methods. The same advantages of anonymous block forwarding apply to rest and keyword rest argument forwarding. This has some minor changes to #parameters output. Now, instead of `[:rest], [:keyrest]`, you get `[:rest, :*], [:keyrest, :**]`. These were already used for `...` forwarding, so I think it makes it more consistent to include them in other cases. If we want to use `[:rest], [:keyrest]` in both cases, that is also possible. I don't think the previous behavior of `[:rest], [:keyrest]` in the non-... case and `[:rest, :*], [:keyrest, :**]` in the ... case makes sense, but if we did want that behavior, we'll have to make more substantial changes, such as using a different ID in the ... forwarding case. Implements [Feature #18351] Notes: Merged: https://github.com/ruby/ruby/pull/5148
2021-11-18Anonymous block forwarding allows a method to forward a passedJeremy Evans
block to another method without having to provide a name for the block parameter. Implements [Feature #11256] Co-authored-by: Yusuke Endoh mame@ruby-lang.org Co-authored-by: Nobuyoshi Nakada nobu@ruby-lang.org Notes: Merged: https://github.com/ruby/ruby/pull/5051
2021-05-11Update keyword argument description in method syntax guideJeremy Evans
Remove discussion of Ruby 2.7 specific handling of keyword argument separation. Add a small example of keyword to positional hash conversion for methods not accepting keyword arguments.
2021-04-25[Doc] Fix a typo s/invokations/invocations/wonda-tea-coffee
Notes: Merged: https://github.com/ruby/ruby/pull/4409
2020-12-26methods.rdoc: Improve method definition documentationMarcus Stollsteimer
* typos, grammar, formatting * use `concrete_method` again in `regular_method` example, to better distinguish from `forwarding_method` example * clarify that leading arguments before `...` require Ruby 3.0
2020-12-26methods.rdoc: Clarify "currently" means "in 2.7" hereMarcus Stollsteimer
2020-12-25Update method definition documentationzverok
* Add endless methods * Add argument forwarding ... Notes: Merged: https://github.com/ruby/ruby/pull/3997
2020-12-25Adjusted the heading level of "Block Arguments" [ci skip]Nobuyoshi Nakada
2020-01-17Update documentation for Array/Hash Argument section of methods.rdocAdam Isom
Notes: Merged: https://github.com/ruby/ruby/pull/2844
2019-12-24[DOC] Fix typoMarcus Stollsteimer
2019-10-03Add documentation regarding keyword argument separation [ci skip]Jeremy Evans
2019-10-03Minor updates to methods and calling_methods documentation [ci skip]Jeremy Evans
2019-07-19Document use of ensure and else at method level [ci skip]Jeremy Evans
2019-07-19Remove section on performance advantage of not using a block parameter [ci skip]Jeremy Evans
Improvements in Ruby 2.5 and 2.6 make this section no longer accurate.
2019-07-19Remove mention of Proc.new with implicit block [ci skip]Jeremy Evans
This support is now deprecated and will be removed in Ruby 3.
2019-07-19Document evaluation order of arguments [ci skip]Jeremy Evans
Fixes [Misc #8905]
2019-07-19Document required keyword argument syntax [ci skip]Jeremy Evans
Fixes [Bug #8952]
2017-10-22doc/syntax/methods.rdoc: fix a misleading examplerhe
As a bonus, wrap a long line added by r60295. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60346 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-10-21* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60296 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-10-21Clarify return value for assignment methods.hsbt
https://github.com/ruby/ruby/pull/1682 Patch by @sos4nt [fix GH-1682] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60295 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-03-29methods.rdoc: small improvementsstomar
* doc/syntax/methods.rdoc: [DOC] small improvements: fix some typos, grammar, punctuation, consistently use capitalized "Ruby". git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58215 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-05-21methods.rdoc: closing tagnobu
* doc/syntax/methods.rdoc (Method Names): add proper closing tag. [Fix GH-1356] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@55094 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-12-18* doc/syntax/*.rdoc: separated modifier at sentence.hsbt
[ci skip][fix GH-1121] Patch by @clandry94 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53182 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-04-15* doc/contributors.rdoc: fix a typo. Patch by @davydovantonhsbt
[fix GH-872][ci skip] * doc/syntax/methods.rdoc: ditto. * ext/digest/sha2/sha2.c: ditto. * ext/socket/ipsocket.c: ditto. * ext/tk/*: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@50320 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-03-04* doc/syntax/methods.rdoc: add some missing spaces andhsbt
fix a grammatical error in method docs. [fix GH-843][ci skip] Patch by @nikolas git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@49838 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-09-23doc: remove trailing spacesnobu
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@47689 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-09-22* doc/syntax/methods.rdoc: [DOC] [] and []= methods by @processzzak
[Fixes GH-662] https://github.com/ruby/ruby/pull/662 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@47685 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-03-06* doc/syntax/methods.rdoc: [DOC] Fix example for block arguments [ci skip]zzak
By @idupree [Fixes GH-554] https://github.com/ruby/ruby/pull/554 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@45276 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-12-22* doc/syntax/methods.rdoc: [DOC] Added example for underscorezzak
conventions in method names. Also added doc to clarify encoding character set support for Ruby programs and elaborated on defining predicate and bang methods. Based on a patch by @gaurish [Fixes GH-477] https://github.com/ruby/ruby/pull/477 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@44350 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-19 * doc/syntax/assignment.rdoc: Improved linksdrbrain
* doc/syntax/methods.rdoc: ditto. * doc/syntax.rdoc: Added link to assignment document git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38880 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-18* doc/syntax/methods.rdoc: Added Array Decomposition.drbrain
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38872 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-15* doc/syntax/calling_methods.rdoc: Link to defining methods.drbrain
* doc/syntax/methods.rdoc: Link to calling methods, fixed typo. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38843 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-15* doc/syntax/methods.rdoc: Fixed linkdrbrain
* doc/syntax/modules_and_classes.rdoc: Fixed link * doc/syntax.rdoc: Updated with links to the recently added pages git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38842 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-15* doc/syntax/methods.rdoc (Method Names): Added method names includingdrbrain
operator methods. * doc/syntax/methods.rdoc (Return Values): Added note that assignment methods ignore return values. * doc/syntax/precedence.rdoc: Added document describing precedence. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38825 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-15* doc/syntax/methods.rdoc (Block Argument): Added section on blockdrbrain
argument. Thanks to Andy Lindeman. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38824 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-15* doc/syntax/methods.rdoc (Array/Hash Argument): Moved above Keyworddrbrain
Arguments * doc/syntax/methods.rdoc (Keyword Arguments): Described ** for gathering arbitrary keyword arguments. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38817 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-05* doc/syntax/modules_and_classes.rdoc: Added documentation of syntaxdrbrain
for Modules and Classes. * doc/syntax/methods.rdoc: Moved some text to the Modules and Classes syntax document. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38701 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-01-04* doc/syntax/methods.rdoc: Added return values and scope sections,drbrain
slightly modified from the original patch. Fixes #227 from github by Dave Brown. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38700 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-12-19* doc/syntax/methods.rdoc: rdoc fix, patch by Dave Brownmarcandre
[github:222] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38465 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-12-19* doc/syntax/methods.rdoc: Fixed typo. Thanks to Josh Susser.drbrain
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38462 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-12-19 * doc/syntax/methods.rdoc: Add () around keyword arguments example fordrbrain
consistency. Thanks to Josh Susser. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38459 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-12-17* doc/syntax/methods.rdoc: Added a description of singleton methods.drbrain
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38421 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-12-17* doc/syntax.rdoc: Added syntax guide table of contentsdrbrain
* doc/syntax/exceptions.rdoc: Syntax guide for exceptions * doc/syntax/literals.rdoc: Syntax guide for literals * doc/syntax/methods.rdoc: Syntax guide for methods git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38419 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-16 19:47:55 +0000