Skip to content

Escape dollar signs for variables in doc comments#8290

Merged
lrytz merged 1 commit intoscala:2.12.xfrom
ashawley:docs-escape-variables
Aug 16, 2019
Merged

Escape dollar signs for variables in doc comments#8290
lrytz merged 1 commit intoscala:2.12.xfrom
ashawley:docs-escape-variables

Conversation

@ashawley
Copy link
Member

A lot of warnings are emitted for undefined variables. For example:

[warn] src/library/scala/util/matching/Regex.scala:62:41: Variable year undefined in comment for class Regex in class Regex
[warn]  *    case date(year, month, day) => s"$year was a good year for PLs."
[warn]                                         ^
[warn] src/library/scala/util/matching/Regex.scala:81:33: Variable year undefined in comment for class Regex in class Regex
[warn]  *    case date(year, _*) => s"$year was a good year for PLs."
[warn]                                 ^
[warn] src/library/scala/util/matching/Regex.scala:132:48: Variable d undefined in comment for class Regex in class Regex
[warn]  *    if (mi.group(1).toInt < 1960) println(s"$d: An oldie but goodie.")
[warn]                                                ^
[warn] src/library/scala/util/matching/Regex.scala:176:96: Variable c undefined in comment for class Regex in class Regex
[warn]  *  val months      = (0 to 11).map { i => val c = Calendar.getInstance; c.set(2014, i, 1); f"$c%tb" }
[warn]                                                                                                ^
[warn] src/library/scala/util/matching/Regex.scala:177:81: Variable months(m.toInt - 1) undefined in comment for class Regex in class Regex
[warn]  *  val reformatted = date.replaceAllIn(dates, _ match { case date(y,m,d) => f"${months(m.toInt - 1)} $d, $y" })
[warn]                                                                                 ^
[warn] src/library/scala/util/matching/Regex.scala:177:104: Variable d undefined in comment for class Regex in class Regex
[warn]  *  val reformatted = date.replaceAllIn(dates, _ match { case date(y,m,d) => f"${months(m.toInt - 1)} $d, $y" })
[warn]                                                                                                        ^
[warn] src/library/scala/util/matching/Regex.scala:177:108: Variable y undefined in comment for class Regex in class Regex

@scala-jenkins scala-jenkins added this to the 2.12.10 milestone Jul 31, 2019
@ashawley
Copy link
Member Author

This should merge forward to 2.13 with no problem, but you can verify with:

git rebase --onto 2.13.x HEAD^

Once merged to 2.13, there are more to fix (e.g. partest and new collections).

Copy link
Contributor

@som-snytt som-snytt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, those were my examples in Regex.

@ashawley ashawley added the documentation No code change. Only documentation label Aug 15, 2019
@lrytz lrytz merged commit 64a883c into scala:2.12.x Aug 16, 2019
@lrytz
Copy link
Member

lrytz commented Aug 16, 2019

Thank you!

@ashawley ashawley deleted the docs-escape-variables branch August 16, 2019 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation No code change. Only documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants