Skip to content

Commit b2a3f44

Browse files
docs: Add rationale of PureConfigModule
1 parent 459b8f2 commit b2a3f44

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

example/src/main/mdoc/pureconfig.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This module allows you to load your application's configuration file according t
88
[PureConfig](https://pureconfig.github.io) library to do so which uses [Lightbend Config](https://github.com/lightbend/config) which means
99
that your application's configuration will be in [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) format.
1010

11+
Loading of configuration is side-effectful so it is wrapped in `F` which is `Sync`. This module also tweaks the error messages a little.
1112

1213
```scala mdoc
1314
import com.avast.server.toolkit.pureconfig._
@@ -21,4 +22,4 @@ final case class ServerConfiguration(listenAddress: String, listenPort: Int)
2122
implicit val serverConfigurationReader: ConfigReader[ServerConfiguration] = deriveReader
2223

2324
val maybeConfiguration = PureConfigModule.make[Task, ServerConfiguration]
24-
```
25+
```

0 commit comments

Comments
 (0)