diff options
| -rw-r--r-- | ChangeLog | 6 | ||||
| -rw-r--r-- | doc/syntax/methods.rdoc | 12 |
2 files changed, 12 insertions, 6 deletions
@@ -1,3 +1,9 @@ +Wed Mar 4 10:15:37 2015 SHIBATA Hiroshi <shibata.hiroshi@gmail.com> + + * doc/syntax/methods.rdoc: add some missing spaces and + fix a grammatical error in method docs. + [fix GH-843][ci skip] Patch by @nikolas + Wed Mar 4 02:13:06 2015 NAKAMURA Usaku <usa@ruby-lang.org> * tool/redmine-backporter.rb (backport_command_string): pick up only diff --git a/doc/syntax/methods.rdoc b/doc/syntax/methods.rdoc index 2c01810b4c..debfa76cbf 100644 --- a/doc/syntax/methods.rdoc +++ b/doc/syntax/methods.rdoc @@ -47,16 +47,16 @@ exist on all keyboards. Method names may end with a <code>!</code> (bang or exclamation mark), a <code>?</code> (question mark) or <code>=</code> equals sign. -The bang methods(<code>!</code> at the end of method name) are called and +The bang methods (<code>!</code> at the end of method name) are called and executed just like any other method. However, by convention, a method with an exclamation point or bang is considered dangerous. In ruby core library the -dangerous method implies that when a method ends with a bang(<code>!</code>), +dangerous method implies that when a method ends with a bang (<code>!</code>), it indicates that unlike its non-bang equivalent, permanently modifies its receiver. Almost always, Ruby core library will have a non-bang -counterpart(method name which does NOT end with <code>!</code>) of every bang -method (method name which does end with <code>!</code>) that has does not -modify the receiver. This convention is typically true for ruby core libary but -may/may not hold true for other ruby libraries. +counterpart (method name which does NOT end with <code>!</code>) of every bang +method (method name which does end with <code>!</code>) that does not modify +the receiver. This convention is typically true for ruby core libary but +may or may not hold true for other ruby libraries. Methods that end with a question mark by convention return boolean. But they may not always return just +true+ or +false+. Often they will may return an |