From c5e9d76221ffc87cb8f0a119cf7953937a14491f Mon Sep 17 00:00:00 2001 From: hsbt Date: Wed, 4 Mar 2015 01:15:43 +0000 Subject: [PATCH] * doc/syntax/methods.rdoc: add some missing spaces and 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 --- ChangeLog | 6 ++++++ doc/syntax/methods.rdoc | 12 ++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/ChangeLog b/ChangeLog index d7f723541f9de7..b878f7cdcc4a1d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Wed Mar 4 10:15:37 2015 SHIBATA Hiroshi + + * 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 * tool/redmine-backporter.rb (backport_command_string): pick up only diff --git a/doc/syntax/methods.rdoc b/doc/syntax/methods.rdoc index 2c01810b4caa2e..debfa76cbf7f02 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 ! (bang or exclamation mark), a ? (question mark) or = equals sign. -The bang methods(! at the end of method name) are called and +The bang methods (! 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(!), +dangerous method implies that when a method ends with a bang (!), 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 !) of every bang -method (method name which does end with !) 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 !) of every bang +method (method name which does end with !) 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