From f7408469ce50214738178fa522287b8a0ec8ef7f Mon Sep 17 00:00:00 2001 From: kpbochenek Date: Tue, 19 May 2020 11:44:06 +0200 Subject: [PATCH] Always display types in worksheets --- .../worksheets/WorksheetProvider.scala | 9 +++++- .../tests/worksheets/WorksheetSuite.scala | 30 +++++++++---------- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/mdoc/src/main/scala/mdoc/internal/worksheets/WorksheetProvider.scala b/mdoc/src/main/scala/mdoc/internal/worksheets/WorksheetProvider.scala index ab93bc11e..ef039c344 100644 --- a/mdoc/src/main/scala/mdoc/internal/worksheets/WorksheetProvider.scala +++ b/mdoc/src/main/scala/mdoc/internal/worksheets/WorksheetProvider.scala @@ -131,8 +131,15 @@ class WorksheetProvider(settings: Settings) { out .append(if (out.isEmpty) "" else ", ") .append(binder.name) - .append("=") + .append(": ") + .append(binder.tpeString) + .append(" = ") } + if (isSingle) + out + .append(": ") + .append(binder.tpeString) + .append(" = ") val chunk = BlackWhite .tokenize(binder.value, width = margin - out.length) .map(_.getChars) diff --git a/tests/worksheets/src/test/scala/tests/worksheets/WorksheetSuite.scala b/tests/worksheets/src/test/scala/tests/worksheets/WorksheetSuite.scala index 428fc131f..c931ea737 100644 --- a/tests/worksheets/src/test/scala/tests/worksheets/WorksheetSuite.scala +++ b/tests/worksheets/src/test/scala/tests/worksheets/WorksheetSuite.scala @@ -42,7 +42,7 @@ class WorksheetSuite extends BaseSuite { |val x = 1.to(4).toVector |""".stripMargin, """| - | // Vector(1, 2, 3, 4) + | // : Vector[Int] = Vect... |x: Vector[Int] = Vector(1, 2, 3, 4) |""".stripMargin ) @@ -54,7 +54,7 @@ class WorksheetSuite extends BaseSuite { |val y = 1.0 |""".stripMargin, """|lazy val x = 0.0 - | // 1.0 + | // : Double = 1.0 |y: Double = 1.0 |""".stripMargin ) @@ -65,7 +65,7 @@ class WorksheetSuite extends BaseSuite { |val List(x, y) = List(1, 2) |""".stripMargin, """| - | // x=1, y=2 + | // x: Int = 1, y: Int =... |x: Int = 1 |y: Int = 2 |""".stripMargin @@ -77,7 +77,7 @@ class WorksheetSuite extends BaseSuite { |Stream.from(10) |""".stripMargin, """| - | // Stream(10,11,12,13,1... + | // : Stream[Int] = Stre... |res0: Stream[Int] = Stream( | 10, | 11, @@ -111,7 +111,7 @@ class WorksheetSuite extends BaseSuite { | // 42 + |}> // : Int = 42 |x: Int = 42 |// hello |""".stripMargin @@ -125,11 +125,11 @@ class WorksheetSuite extends BaseSuite { |val m = n * 10 |""".stripMargin, """| - | // 10 + | // : Int = 10 |n: Int = 10 | // 10 |// 10 - | // 100 + | // : Int = 100 |m: Int = 100 |""".stripMargin ) @@ -140,7 +140,7 @@ class WorksheetSuite extends BaseSuite { |val n = Future.successful(10) |""".stripMargin, """|import scala.concurrent.Future - | // Future(Success(10)) + | // : Future[Int] = Futu... |n: Future[Int] = Future(Success(10)) |""".stripMargin ) @@ -148,7 +148,7 @@ class WorksheetSuite extends BaseSuite { // From 2.13 we get `name =` part val definitionCompat = """|case class User(name: String) - | // User(name = "Susan") + | // : User = User(name =... |n: User = User(name = "Susan") |""".stripMargin @@ -158,7 +158,7 @@ class WorksheetSuite extends BaseSuite { |val n = User("Susan") |""".stripMargin, """|case class User(name: String) - | // User("Susan") + | // : User = User("Susan... |n: User = User("Susan") |""".stripMargin, compat = Map( @@ -224,7 +224,7 @@ class WorksheetSuite extends BaseSuite { |val y = "foobar".stripSuffix("bar") |""".stripMargin, """| - | // "foo" + | // : String = "foo" |x: String = "foo" |""".stripMargin ) @@ -260,17 +260,17 @@ class WorksheetSuite extends BaseSuite { """|case class Circle(x: Double, y: Double, radius: Double) |extension (c: Circle) | def circumference: Double = c.radius * math.Pi * 2 - | // Circle(x = 0.0,y = 0... + | // : Circle = Circle(x ... |circle: Circle = Circle( | x = 0.0, | y = 0.0, | radius = 2.0 |) - | // 12.566370614359172 + | // : Double = 12.566370... |res0: Double = 12.566370614359172 |extension [T](xs: List[T]) | def second = xs.tail.head - | // 2 + | // : Int = 2 |res1: Int = 2 |""".stripMargin ) @@ -285,7 +285,7 @@ class WorksheetSuite extends BaseSuite { """|import $dep.`org.json4s:json4s-native_2.13:3.6.9` |import org.json4s._ |import org.json4s.native.JsonMethods._ - | // JObject(obj = List((... + | // : JValue = JObject(o... |res0: JValue = JObject( | obj = List( | (