Skip to content

Commit

Permalink
updated release notes for implicit.ly publishing and fixed formatting…
Browse files Browse the repository at this point in the history
… of asFooConverter sample description
  • Loading branch information
jeichar committed Mar 3, 2011
1 parent 0aec2ed commit 60da397
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 11 deletions.
10 changes: 5 additions & 5 deletions core/src/samples/asFooConverter.scala
@@ -1,18 +1,18 @@
import java.io.StringWriter

/**
* Examples for creating Output/Input/ReadChars/WriteChars etc... using the asFooConverter pattern.
* Examples for creating Output/Input/ReadChars/WriteChars/etc using the asFooConverter pattern.
*
* There are two patterns for creating IO objects. One is using the Resources API. This is often the best for
* creating resources from closeable objects such as InputStreams. The Resource API takes a code block for constructing
* the resource and can there for recreate the resource when needed.
*
* <br/>
* The other pattern is to convert an existing object to an Input/Ouput/ReadChars/WriteChars/Seekable object. The
* idea here is to import the implicit conversions contained in the target object (Input/Ouput/ReadChars/WriteChars/Seekable)
* and then call the asInput//Ouput/ReadChars/WriteChars/Seekable.
*
* and then call the asInput//Ouput/ReadChars/WriteChars/Seekable.
* <br/>
* Examples of the latter pattern are described here.
*
* <br/>
* Note: In all examples where a codec is required, the codec can be explicitly or implicitly passed
*/
object AsFooConverter {
Expand Down
14 changes: 14 additions & 0 deletions notes/0.1.1.markdown
@@ -0,0 +1,14 @@
Two critical bugs with 0.1.0 so I have made a quick patch release to fix the issue.

Specifically the bugs are:

* [Input.byteArray iterates through stream twice](https://github.com/jesseeichar/scala-io/issues/closed#issue/3)
* [Resource.fromFileString("...").byteArray goes into an infinite loop](https://github.com/jesseeichar/scala-io/issues/closed#issue/5)

Both are now fixed with the 0.1.1 release.

In addition the following issue was addressed:

* [Add more asFoo converters for converting objects to Input/Output/etc... objects](https://github.com/jesseeichar/scala-io/issues/closed#issue/2)

The files are on scala-tools.org. To get running with Scala IO take a look at http://jesseeichar.github.com/scala-io/getting-started.html
1 change: 1 addition & 0 deletions notes/about.markdown
@@ -0,0 +1 @@
The goal of the Scala IO Project is to create an Input/Output and filesystem access API for Scala.
2 changes: 1 addition & 1 deletion project/build.properties
Expand Up @@ -3,7 +3,7 @@
project.organization=com.github.scala-incubator.io
project.name=ScalaIO
sbt.version=0.7.4
project.version=0.2.0-SNAPSHOT
project.version=0.1.1
build.scala.versions=2.8.1
project.initialize=false
file.encoding=utf8
2 changes: 1 addition & 1 deletion project/build/ScalaIOProject.scala
Expand Up @@ -154,7 +154,7 @@ class ScalaIOProject(info: ProjectInfo)
}
}

trait IoProject extends AutoCompilerPlugins with MavenPublishing{
trait IoProject extends AutoCompilerPlugins with MavenPublishing {
self : DefaultProject =>

override def documentOptions = super.documentOptions //++ List(CompoundDocOption("-doc-source-url","https://github.com/scala-incubator/scala-io/raw/master/"))
Expand Down
4 changes: 2 additions & 2 deletions project/build/WebiteModel.scala
Expand Up @@ -60,11 +60,11 @@ class WebsiteModel(val websiteProj:ScalaIOProject#WebSite, val rootProject:Scala
streams and channels (at least the Java implementation).
</p>
<p>
<strong>Warning #1: </strong>The current API is a very early version and is likely to change.
Warning #1: The current API is a very early version and is likely to change.
That said barring a massive outcry the core components should remain fairly consistent. Both the core and file projects will be changing but file is even more likely to change.
Especially with regard to FileAttributes and the API for implementing custom filesystems.
</p><p>
<strong>Warning #2: </strong>I have spend no time on optimization so there are a large number of
Warning #2: I have spent no time on optimization so there are a large number of
known inefficiencies. Patches and suggestions are welcome but please keep flaming to a minimum.
</p><p>
If you have any suggestions please open a ticket at
Expand Down
5 changes: 3 additions & 2 deletions project/plugins/Plugins.scala
Expand Up @@ -4,6 +4,7 @@ import java.net.URL

class Plugins(info: ProjectInfo) extends PluginDefinition(info)
{
val posterous = "net.databinder" % "posterous-sbt" % "0.1.4"
val technically = Resolver.url("technically.us", new URL("http://databinder.net/repo/"))(Resolver.ivyStylePatterns)
val snuggletex_repo = "snuggletex_repo" at "http://www2.ph.ed.ac.uk/maven2"
val t_repo = "t_repo" at "http://tristanhunt.com:8081/content/groups/public/"
val posterous = "net.databinder" % "posterous-sbt" % "0.1.6"
}

0 comments on commit 60da397

Please sign in to comment.