Skip to content

Commit

Permalink
Release 0.2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
kciesielski committed Jun 7, 2024
1 parent 8d48f6d commit 0079ed3
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ the project!
To test Ox, use the following dependency, using either [sbt](https://www.scala-sbt.org):

```scala
"com.softwaremill.ox" %% "core" % "0.2.0"
"com.softwaremill.ox" %% "core" % "0.2.1"
```

Or [scala-cli](https://scala-cli.virtuslab.org):

```scala
//> using dep "com.softwaremill.ox::core:0.2.0"
//> using dep "com.softwaremill.ox::core:0.2.1"
```

Documentation is available at [https://ox.softwaremill.com](https://ox.softwaremill.com), ScalaDocs can be browsed at [https://javadoc.io](https://www.javadoc.io/doc/com.softwaremill.ox).
Expand Down
4 changes: 2 additions & 2 deletions generated-doc/out/basics/start-here.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

```scala
// sbt dependency
"com.softwaremill.ox" %% "core" % "0.2.0"
"com.softwaremill.ox" %% "core" % "0.2.1"

// scala-cli dependency
//> using dep "com.softwaremill.ox::core:0.2.0"
//> using dep "com.softwaremill.ox::core:0.2.1"
```

## Scope of the Ox project
Expand Down
15 changes: 13 additions & 2 deletions generated-doc/out/io.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ To use the plugin, add the following settings to your sbt configuration:

```scala
autoCompilerPlugins := true
addCompilerPlugin("com.softwaremill.ox" %% "plugin" % "0.2.0")
addCompilerPlugin("com.softwaremill.ox" %% "plugin" % "0.2.1")
```

For scala-cli:

```scala
//> using plugin com.softwaremill.ox:::plugin:0.2.0
//> using plugin com.softwaremill.ox:::plugin:0.2.1
```

With the plugin enabled, the following code won't compile:
Expand Down Expand Up @@ -127,3 +127,14 @@ Currently, by default the plugin checks for the following exceptions:

* `java.io.IOException`
* `java.sql.SQLException`

## Potential benefits of tracking methods that perform I/O

Tracking which methods perform I/O using the `IO` capability has the only benefit of giving you method signatures,
which carry more information. In other words: more type safety. The specific benefits might include:

* better code readability (what does this method do?
* local reasoning (does this method perform I/O?)
* safer refactoring (adding I/O to a previously pure method triggers errors in the compiler, you need to consciously add the capability)
* documentation through types (an IO method can take a longer time, have side-effects)
* possible failure modes (an IO method might throw an exception)
2 changes: 1 addition & 1 deletion generated-doc/out/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Dependency:

```scala
"com.softwaremill.ox" %% "kafka" % "0.2.0"
"com.softwaremill.ox" %% "kafka" % "0.2.1"
```

`Source`s which read from a Kafka topic, mapping stages and drains which publish to Kafka topics are available through
Expand Down

0 comments on commit 0079ed3

Please sign in to comment.