Skip to content

Commit 22f2f62

Browse files
abgruszeckiromanowski
authored andcommitted
Make warning messages more presentable
1 parent 92dbf8d commit 22f2f62

File tree

2 files changed

+6
-13
lines changed

2 files changed

+6
-13
lines changed

scala3doc/src/dotty/dokka/tasty/comments/BaseConverter.scala

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ trait BaseConverter {
1010
protected def withParsedQuery(queryStr: String)(thunk: Query => dkkd.DocTag): dkkd.DocTag = {
1111
QueryParser(queryStr).tryReadQuery() match {
1212
case Left(err) =>
13+
val msg = err.getMessage
1314
// TODO: for better experience we should show source location here
14-
println("WARN: " + err.getMessage)
15-
dkkd.A(List(dkk.text(err.getMessage)).asJava, Map("href" -> "#").asJava)
15+
println("WARN: " + msg)
16+
dkkd.A(List(dkk.text(queryStr)).asJava, Map("href" -> "#").asJava)
1617
case Right(query) =>
1718
thunk(query)
1819
}

scala3doc/src/dotty/dokka/tasty/comments/MarkdownConverter.scala

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -161,17 +161,8 @@ class MarkdownConverter(val repr: Repr) extends BaseConverter {
161161
case _: mda.SoftLineBreak => emit(dkkd.Br.INSTANCE)
162162

163163
case _ =>
164-
println(s"!!! DEFAULTING @ ${n.getNodeName}")
165-
emit(dkkd.P(
166-
List[dkkd.DocTag](
167-
dkkd.Span(
168-
List(dkk.text(s"!!! DEFAULTING @ ${n.getNodeName}")).asJava,
169-
kt.emptyMap,
170-
),
171-
dkk.text(MarkdownParser.renderToText(n))
172-
).asJava,
173-
kt.emptyMap[String, String]
174-
))
164+
println(s"WARN: Encountered unrecognised Markdown node `${n.getNodeName}`, please open an issue.")
165+
emit(dkk.text(MarkdownParser.renderToText(n)))
175166
}
176167

177168
def extractAndConvertSummary(doc: mdu.Document): Option[dkkd.DocTag] =
@@ -189,6 +180,7 @@ class MarkdownConverter(val repr: Repr) extends BaseConverter {
189180
case Some((sym, targetText)) =>
190181
dkkd.DocumentationLink(sym.dri, resolveBody(default = targetText), kt.emptyMap)
191182
case None =>
183+
println(s"WARN: Definition lookup for following query failed: $queryStr")
192184
dkkd.A(resolveBody(default = query.join), Map("href" -> "#").asJava)
193185
}
194186
}

0 commit comments

Comments
 (0)