Merge pull request #32 from packetloop/more-documentation

More documentation

Author: newhoggy

README.md

@@ -14,7 +14,7 @@ Add this to your SBT project:
 ```
 resolvers += "dl-john-ky-releases" at "http://dl.john-ky.io/maven/releases"
 
-libraryDependencies += "org.pico" %%  "pico-disposal" % "1.0.9"
+libraryDependencies += "org.pico" %%  "pico-disposal" % "1.0.10"
 ```
 
 Then read the [tutorial](pico-disposal/src/main/tut/tutorial.md).

pico-disposal/src/main/tut/tutorial.md

@@ -249,7 +249,7 @@ to it.
 
 Do bear in mind, this will only ensure proper cleanup of resources if exceptions are never thrown
 from within the constructor body outsided of the `disposesOrCloses` by-name parameter.  For a safer
-way of constructing complex resources see [Constructing complex resources safely](# Constructing complex resources safely)
+way of constructing complex resources see [Constructing complex resources safely](#Constructing complex resources safely)
 
 ## Other features
 ### Closed object
@@ -335,14 +335,14 @@ assert(closeableRef.get() == Closed)
 
 Use `Part` in a for comprehension to safely construct composite resources:
 
-```tut
+```tut:reset
 import java.io.Closeable
 
+import org.pico.disposal._
 import org.pico.disposal.std.autoCloseable._
+import org.pico.disposal.syntax.disposable._
 import org.specs2.mutable.Specification
 
-import scala.util.control.NonFatal
-
 class Resource extends Closeable {
   override def close(): Unit = ()
 }
@@ -365,3 +365,33 @@ val composite: Composite = {
   } yield Composite(a, a, a)
 }
 ```
+
+### Tuples of disposables
+
+In situations when a function needs to return two disposable objects, it is possible to acquire them safely
+using tuple support:
+
+```tut:reset
+import java.io.Closeable
+
+import org.pico.disposal._
+import org.pico.disposal.std.autoCloseable._
+import org.pico.disposal.std.tuple._
+import org.specs2.mutable.Specification
+
+var value: Int = 0
+
+def createTwoResources(): (Closeable, Closeable) = {
+  (OnClose(value += 1), OnClose(value += 2))
+}
+
+for {
+  (a, b) <- Auto(createTwoResources())
+} {
+  identity(a: Closeable)
+  identity(b: Closeable)
+}
+
+assert(value == 3)
+```
+

pico-disposal/src/test/scala/org/pico/disposal/TupleSpec.scala

@@ -14,7 +14,7 @@ class TupleSpec extends Specification {
       (a, b) <- Auto((OnClose(value += 1), OnClose(value += 2)))
     } {
       identity(a: Closeable)
-      identity(a: Closeable)
+      identity(b: Closeable)
     }
 
     value must_=== 3

project/Build.scala

@@ -11,7 +11,7 @@ object Build extends sbt.Build {
     def standard(theDescription: String) = {
       self
           .settings(scalacOptions in Test ++= Seq("-Yrangepos"))
-          .settings(publishTo := Some("Releases" at "s3://dl.john-ky.io/maven/releases"))
+          .settings(publishTo := Some("Releases" at Option(System.getenv("PICO_PUBLISH_TO")).getOrElse("no-publishing")))
           .settings(description := theDescription)
           .settings(isSnapshot := true)
           .settings(tutSettings: _*)