Skip to content

Commit 51326b2

Browse files
committed
add doc links to readme
fixes scala#36
1 parent 72a407c commit 51326b2

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,34 @@ If you're using sbt, you can add the dependency as follows:
1313
libraryDependencies += "org.scala-lang.modules" %% "scala-collection-contrib" % "0.1.0"
1414
```
1515

16-
## New collection types
16+
Here is the [full Scaladoc](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/index.html).
1717

18-
- `MultiSet` (both mutable and immutable)
19-
- `SortedMultiSet` (both mutable and immutable)
20-
- `MultiDict` (both mutable and immutable)
21-
- `SortedMultiDict` (both mutable and immutable)
18+
### New collection types
2219

23-
## New operations
20+
These collections are in the `scala.collection` package.
21+
22+
- [`MultiSet`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/MultiSet.html) (both [mutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/mutable/MultiSet.html) and [immutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/immutable/MultiSet.html))
23+
- [`SortedMultiSet`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/SortedMultiSet.html) (both [mutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/mutable/SortedMultiSet.html) and [immutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/immutable/SortedMultiSet.html))
24+
- [`MultiDict`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/MultiDict.html) (both [mutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/mutable/MultiDict.html) and [immutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/immutable/MultiDict.html))
25+
- [`SortedMultiDict`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/SortedMultiDict.html) (both [mutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/mutable/SortedMultiDict.html) and [immutable](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/immutable/SortedMultiDict.html))
26+
27+
### New operations
2428

2529
The new operations are provided via an implicit enrichment. You need to add the following
2630
import to make them available:
2731

28-
~~~ scala
32+
```scala
2933
import scala.collection.decorators._
30-
~~~
34+
```
3135

3236
The following operations are provided:
3337

3438
- `Seq`
35-
- `intersperse`
36-
- `replaced`
39+
- [`intersperse`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/SeqDecorator.html#intersperse[B>:SeqDecorator.this.seq.A,That](start:B,sep:B,end:B\)(implicitbf:scala.collection.BuildFrom[C,B,That]\):That)
40+
- [`replaced`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/SeqDecorator.html#replaced[B>:SeqDecorator.this.seq.A,That](elem:B,replacement:B\)(implicitbf:scala.collection.BuildFrom[C,B,That]\):That)
3741
- `Map`
38-
- `zipByKey` / `join` / `zipByKeyWith`
39-
- `mergeByKey` / `fullOuterJoin` / `mergeByKeyWith` / `leftOuterJoin` / `rightOuterJoin`
42+
- [`zipByKey`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#zipByKey[W,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,(MapDecorator.this.map.V,W\)\),That]\):That) / [`join`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#join[W,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,(MapDecorator.this.map.V,W\)\),That]\):That) / [`zipByKeyWith`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#zipByKeyWith[W,X,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(f:(MapDecorator.this.map.V,W\)=>X\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,X\),That]\):That)
43+
- [`mergeByKey`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#mergeByKey[W,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,(Option[MapDecorator.this.map.V],Option[W]\)\),That]\):That) / [`fullOuterJoin`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#fullOuterJoin[W,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,(Option[MapDecorator.this.map.V],Option[W]\)\),That]\):That) / [`mergeByKeyWith`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#mergeByKeyWith[W,X,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(f:PartialFunction[(Option[MapDecorator.this.map.V],Option[W]\),X]\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,X\),That]\):That) / [`leftOuterJoin`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#leftOuterJoin[W,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,(MapDecorator.this.map.V,Option[W]\)\),That]\):That) / [`rightOuterJoin`](https://static.javadoc.io/org.scala-lang.modules/scala-collection-contrib_2.13/0.1.0/scala/collection/decorators/MapDecorator.html#rightOuterJoin[W,That](other:scala.collection.Map[MapDecorator.this.map.K,W]\)(implicitbf:scala.collection.BuildFrom[C,(MapDecorator.this.map.K,(Option[MapDecorator.this.map.V],W\)\),That]\):That)
4044

4145
## Maintenance status
4246

0 commit comments

Comments
 (0)