Permalink
Browse files

Adding a little Set documentation.

  • Loading branch information...
1 parent 9f5abb8 commit f400c09bbda47f37340d92a46c3e72270dd2b099 @jcoglan jcoglan committed Aug 8, 2008
Showing with 3 additions and 1 deletion.
  1. +3 −1 site/src/pages/set.haml
View
@@ -44,7 +44,9 @@
@Set@ and @SortedSet@ include the "@Enumerable@":/enumerable.html module as long as you
load said module before the @Set@ file. The iteration order for @Set@ is arbitrary and is
not guaranteed, whereas for @SortedSet@ iteration takes place in sort order. The rest of
- the API is as follows:
+ the API is as follows. As a general rule, any method that returns a new set will return
+ a set of the same type as the receiver, i.e. if @set@ is a @Set@ then @set.union(other)@
+ returns a new @Set@, if @set@ is a @SortedSet@ the same call returns a @SortedSet@.
h3. @add(item)@

0 comments on commit f400c09

Please sign in to comment.