summaryrefslogtreecommitdiff
path: root/src/library/scala/collection/readme-if-you-want-to-add-something.txt
diff options
context:
space:
mode:
authorMartin Odersky <odersky@gmail.com>2010-03-24 16:20:32 +0000
committerMartin Odersky <odersky@gmail.com>2010-03-24 16:20:32 +0000
commitcb9f3c3d0ff62c45e316aac6b121db16e8fd859e (patch)
treeb307306646b7581ea46d7501fed415f0de231dbc /src/library/scala/collection/readme-if-you-want-to-add-something.txt
parent64d2ab49ca6d964b4173941bba3d70a781baa261 (diff)
downloadscala-cb9f3c3d0ff62c45e316aac6b121db16e8fd859e.tar.gz
scala-cb9f3c3d0ff62c45e316aac6b121db16e8fd859e.tar.bz2
scala-cb9f3c3d0ff62c45e316aac6b121db16e8fd859e.zip
new readme. no review.
Diffstat (limited to 'src/library/scala/collection/readme-if-you-want-to-add-something.txt')
-rwxr-xr-xsrc/library/scala/collection/readme-if-you-want-to-add-something.txt18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/library/scala/collection/readme-if-you-want-to-add-something.txt b/src/library/scala/collection/readme-if-you-want-to-add-something.txt
index 8fec7648dc..6700cb7b68 100755
--- a/src/library/scala/collection/readme-if-you-want-to-add-something.txt
+++ b/src/library/scala/collection/readme-if-you-want-to-add-something.txt
@@ -3,17 +3,17 @@ Conventions for Collection Implementors
Martin Odersky
19 Mar 2010
-This note decsribes some conventions which must be followed to keep
+This note describes some conventions which must be followed to keep
the collection libraries consistent.
We distinguish in the following between two kinds of methods
- - Accessors access some of the elements of a collection, but return a result which
+ - ``Accessors'' access some of the elements of a collection, but return a result which
is unrelated to the collection.
Example of accessors are: head, foldLeft, indexWhere, toSeq.
- - Transformers access elements of a collection and produce a new collection of related
- type as a result. The relation might either be direct (same type as rceiver)
+ - ``Transformers'' access elements of a collection and produce a new collection of related
+ type as a result. The relation might either be direct (same type as receiver)
or indirect, linked by a CanBuildFrom implicit.
Example of transformers are: filter, map, groupBy, zip.
@@ -21,23 +21,23 @@ We distinguish in the following between two kinds of methods
Every collection type has a Proxy class that forwards all operations to
an underlying collection. Proxy methods are all implemented in classes
-of matching the name template *ProxyLike. If you add a new method to a collection
+with names ending in `ProxyLike'. If you add a new method to a collection
class you need to add the same method to the corresponding ProxyLike class.
2. Forwarders
Classes Traversable, Iterable, and Seq also have forwarders, which
forward all collection-specific accessor operations to an underlying
-collection. These are defined as classes with names matching the
-template *Forwarder in package collection.generic. If you add a new
+collection. These are defined as classes with names ending
+in `Forwarder' in package collection.generic. If you add a new
accessor method to a Seq or one of its collection superclasses, you
need to add the same method to the corresponding forwarder class.
3. Views
Classes Traversable, Iterable, Seq, IndexedSeq, and mutable.IndexedSeq
-support views. Their operations are all defined in classes matching
-the template *ViewLike. If you add a new transformer method to one of
+support views. Their operations are all defined in classes with names
+ending in `ViewLike'. If you add a new transformer method to one of
the above collection classes, you need to add the same method to the
corresponding view class. Failure to do so will cause the
corresponding method to fail at runtime with an exception like