Search for name in range of lines and add flexible sourcelinks #12819
Conversation
romanowski
force-pushed
the
scaladoc/fix-sourcelinks
branch
2 times, most recently
from
41f0805 to
827b301
Compare
romanowski
force-pushed
the
scaladoc/fix-sourcelinks
branch
from
827b301 to
1f7f355
Compare
The problem was caused by stripping extension incorrectly from files
|
Doc generated using this PR - latest blogpost links correctly |
BarkingBad
left a comment
BarkingBad
left a comment
There was a problem hiding this comment.
Changes seem OK, though I have few questions.
| <li> | ||
| <h2> | ||
| <a href="{{ site.baseurl }}{{ post.url }}">{{ post.title }}</a> | ||
| <a href="{{ post.url }}">{{ post.title }}</a> |
There was a problem hiding this comment.
Was site.baseurl empty string?
There was a problem hiding this comment.
yes, we do not expose such setting
| def scalaSrcLink(v: String, s: String) = s"-source-links:$s=github://scala/scala/v$v#src/library" | ||
| def dottySrcLink(v: String, s: String) = s"-source-links:$s=github://lampepfl/dotty/$v#library/src" | ||
| def dottySrcLink(v: String, s: String) = | ||
| sys.env.get("GITHUB_SHA") match { |
There was a problem hiding this comment.
Why do we need this environment variables driven logic?
There was a problem hiding this comment.
The problem is that we want to link to the source code that has been actually used for this PR, not the 3.0.0 sources. Before we tried to link to e.g. experimental.scala that that not exists in 3.0.0
| val toLine = expectedLine + 3 | ||
| val memberToMatch = member.replace("`", "") | ||
| assertTrue(s"Expected to find $memberToMatch at $link at line $line", loc.contains(memberToMatch)) | ||
| val lineCorrectlyDefined = (expectedLine.toInt until toLine.toInt).exists{ line => |
There was a problem hiding this comment.
If I understand it correctly we look for the member in the range of lines. Was there something failing for the exact line match?
There was a problem hiding this comment.
yes, in was the case of name that spans in multiple lines like asMatchable: https://github.com/lampepfl/dotty/blob/3.0.0/library/src/scala/compiletime/package.scala#L169-L170
3 participants
fixes #12762
fixes problems with sourcelink tests