* lib/set.rb: [DOC] Add examples for Set#intersect? and Set#disjoint?

  Patch by xavier nayrac [Bug #9331] [ci skip]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@44724 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

2 files changed, 18 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index 91522d2d6f..1e0063ccba 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Tue Jan 28 15:17:59 2014  Zachary Scott  <[email protected]>
+
+	* lib/set.rb: [DOC] Add examples for Set#intersect? and Set#disjoint?
+	  Patch by xavier nayrac [Bug #9331] [ci skip]
+
 Tue Jan 28 15:12:22 2014  Zachary Scott  <[email protected]>
 
 	* ext/zlib/zlib.c (rb_zlib_adler32): [DOC] Add example for adler32
diff --git a/lib/set.rb b/lib/set.rb
index e30d590c5d..3aebb89376 100644
--- a/lib/set.rb
+++ b/lib/set.rb
@@ -240,6 +240,12 @@ class Set
 
   # Returns true if the set and the given set have at least one
   # element in common.
+  #
+  # e.g.:
+  #
+  #   require 'set'
+  #   Set[1, 2, 3].intersect? Set[4, 5] # => false
+  #   Set[1, 2, 3].intersect? Set[3, 4] # => true
   def intersect?(set)
     set.is_a?(Set) or raise ArgumentError, "value must be a set"
     if size < set.size
@@ -251,6 +257,13 @@ class Set
 
   # Returns true if the set and the given set have no element in
   # common.  This method is the opposite of +intersect?+.
+  #
+  # e.g.:
+  #
+  #   require 'set'
+  #   Set[1, 2, 3].disjoint? Set[3, 4] # => false
+  #   Set[1, 2, 3].disjoint? Set[4, 5] # => true
+
   def disjoint?(set)
     !intersect?(set)
   end