Skip to content

Commit f2f1621

Browse files
authored
Merge pull request #187 from lolgab/fix-docs-scala-3
Update docs to compile on Scala 3
2 parents d3d21ce + 9c82368 commit f2f1621

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

docs/getting-started.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,18 @@ libraryDependencies += "com.geirsson" %% "metaconfig-typesafe-config" % "@VERSIO
3737
Next, write a case class for your user configuration.
3838

3939
```scala mdoc
40+
import metaconfig._
41+
import metaconfig.generic._
42+
4043
case class HelloConfig(
4144
verbose: Boolean = false,
4245
name: String = "Susan"
4346
)
4447
object HelloConfig {
4548
lazy val default = HelloConfig()
46-
implicit lazy val surface = metaconfig.generic.deriveSurface[HelloConfig]
47-
implicit lazy val decoder = metaconfig.generic.deriveDecoder[HelloConfig](default)
48-
implicit lazy val encoder = metaconfig.generic.deriveEncoder[HelloConfig]
49+
implicit lazy val surface: Surface[HelloConfig] = deriveSurface[HelloConfig]
50+
implicit lazy val decoder: ConfDecoder[HelloConfig] = deriveDecoder[HelloConfig](default)
51+
implicit lazy val encoder: ConfEncoder[HelloConfig] = deriveEncoder[HelloConfig]
4952
}
5053
```
5154

docs/reference.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ automatically derive a `ConfEncoder[T]` instance for any case class with
234234
`generic.deriveEncoder`.
235235

236236
```scala mdoc
237-
implicit val encoder = generic.deriveEncoder[User]
237+
implicit val encoder: ConfEncoder[User] = generic.deriveEncoder[User]
238238

239239
ConfEncoder[User].write(User("John", 42))
240240
```
@@ -257,8 +257,8 @@ It's common to have a class that has both a `ConfDecoder[T]` and
257257

258258
```scala mdoc:silent
259259
case class Bijective(name: String)
260-
implicit val surface = generic.deriveSurface[Bijective]
261-
implicit val codec = generic.deriveCodec[Bijective](new Bijective("default"))
260+
implicit val surface: generic.Surface[Bijective] = generic.deriveSurface[Bijective]
261+
implicit val codec: ConfCodec[Bijective] = generic.deriveCodec[Bijective](new Bijective("default"))
262262
```
263263

264264
```scala mdoc
@@ -429,8 +429,10 @@ case class EvolvingConfig(
429429
@DeprecatedName("goodName", "Use isGoodName instead", "1.0")
430430
isGoodName: Boolean
431431
)
432-
implicit val surface = generic.deriveSurface[EvolvingConfig]
433-
implicit val decoder = generic.deriveDecoder[EvolvingConfig](EvolvingConfig(true)).noTypos
432+
implicit val surface: generic.Surface[EvolvingConfig] =
433+
generic.deriveSurface[EvolvingConfig]
434+
implicit val decoder: ConfDecoder[EvolvingConfig] =
435+
generic.deriveDecoder[EvolvingConfig](EvolvingConfig(true)).noTypos
434436
```
435437

436438
```scala mdoc
@@ -555,8 +557,8 @@ case class Home(
555557
@Description("Country description")
556558
country: String = "Iceland"
557559
)
558-
implicit val homeSurface = generic.deriveSurface[Home]
559-
implicit val homeEncoder = generic.deriveEncoder[Home]
560+
implicit val homeSurface: Surface[Home] = generic.deriveSurface[Home]
561+
implicit val homeEncoder: ConfEncoder[Home] = generic.deriveEncoder[Home]
560562

561563
case class User(
562564
@Description("Name description")
@@ -565,8 +567,8 @@ case class User(
565567
age: Int = 42,
566568
home: Home = Home()
567569
)
568-
implicit val userSurface = generic.deriveSurface[User]
569-
implicit val userEncoder = generic.deriveEncoder[User]
570+
implicit val userSurface: Surface[User] = generic.deriveSurface[User]
571+
implicit val userEncoder: ConfEncoder[User] = generic.deriveEncoder[User]
570572
```
571573

572574
To generate html documentation, pass in a default value

0 commit comments

Comments
 (0)