RUBY-1021 Document #reject! and #select! returning nil if unchanged

estolfo · estolfo · commit 25a87b9db61e · 2015-09-10T14:16:23.000-04:00
diff --git a/lib/mongo/options/redacted.rb b/lib/mongo/options/redacted.rb
@@ -87,7 +87,7 @@ def reject(&block)
       #
       # @yieldparam [ String, Object ] The key as a string and its value.
       #
-      # @return [ Options::Redacted ] This object.
+      # @return [ Options::Redacted, nil ] This object or nil if no changes were made.
       #
       # @since 2.1.0
       def reject!
@@ -124,7 +124,7 @@ def select(&block)
       #
       # @yieldparam [ String, Object ] The key as a string and its value.
       #
-      # @return [ Options::Redacted ] This object.
+      # @return [ Options::Redacted, nil ] This object or nil if no changes were made.
       #
       # @since 2.1.0
       def select!

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ def reject(&block)`
`87`	`87`	`#`
`88`	`88`	`# @yieldparam [ String, Object ] The key as a string and its value.`
`89`	`89`	`#`
`90`		`- # @return [ Options::Redacted ] This object.`
	`90`	`+ # @return [ Options::Redacted, nil ] This object or nil if no changes were made.`
`91`	`91`	`#`
`92`	`92`	`# @since 2.1.0`
`93`	`93`	`def reject!`
`@@ -124,7 +124,7 @@ def select(&block)`
`124`	`124`	`#`
`125`	`125`	`# @yieldparam [ String, Object ] The key as a string and its value.`
`126`	`126`	`#`
`127`		`- # @return [ Options::Redacted ] This object.`
	`127`	`+ # @return [ Options::Redacted, nil ] This object or nil if no changes were made.`
`128`	`128`	`#`
`129`	`129`	`# @since 2.1.0`
`130`	`130`	`def select!`