Post History
Scan the documentation for the Ruby standard library, which includes numerous examples. I quickly scanned the some YAML parser classes, and the idea seems to be to simply describe how a method will...
Answer
#3: Attribution notice added
Source: https://writers.stackexchange.com/a/8490 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
Scan the documentation for the Ruby standard library, which includes numerous examples. I quickly scanned the [some YAML parser classes](http://www.ruby-doc.org/stdlib-2.0/libdoc/psych/rdoc/Psych.html#method-c-load), and the idea seems to be to simply describe how a method will use its parameters. In many cases, the use isn't described, and mostly I can guess the use from the name of the parameter.