ruby-changes:37757
From: hsbt <ko1@a...>
Date: Wed, 4 Mar 2015 10:15:51 +0900 (JST)
Subject: [ruby-changes:37757] hsbt:r49838 (trunk): * doc/syntax/methods.rdoc: add some missing spaces and
hsbt 2015-03-04 10:15:43 +0900 (Wed, 04 Mar 2015) New Revision: 49838 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=49838 Log: * doc/syntax/methods.rdoc: add some missing spaces and fix a grammatical error in method docs. [fix GH-843][ci skip] Patch by @nikolas Modified files: trunk/ChangeLog trunk/doc/syntax/methods.rdoc Index: doc/syntax/methods.rdoc =================================================================== --- doc/syntax/methods.rdoc (revision 49837) +++ doc/syntax/methods.rdoc (revision 49838) @@ -47,16 +47,16 @@ exist on all keyboards. https://github.com/ruby/ruby/blob/trunk/doc/syntax/methods.rdoc#L47 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 Index: ChangeLog =================================================================== --- ChangeLog (revision 49837) +++ ChangeLog (revision 49838) @@ -1,3 +1,9 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1 +Wed Mar 4 10:15:37 2015 SHIBATA Hiroshi <shibata.hiroshi@g...> + + * 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@r...> * tool/redmine-backporter.rb (backport_command_string): pick up only -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/