Fix Scaladoc overloaded method link to Duration companion object#4886
Fix Scaladoc overloaded method link to Duration companion object#4886SethTisue merged 1 commit intoscala:2.11.xfrom
Conversation
15b5b85 to
f0b54f1
Compare
|
Fixing this required some experimentation which I have noted here for the benefit or amusement of future wanderers.
The outcome of Test 3 is forever lost in the swirling chaos of Going by this post the tests that warn and include the result type could be fixed by using the fully qualified name of the result type. I see no point in including the result type when distinguishing overloads. http://stackoverflow.com/questions/23181672/cannot-create-scaladoc-link-for-overloaded-method Test 1 is interesting. When more than one target is identified the link is made but it could be to the wrong method. Is a best effort approach really helping the author? Failing hard would help when a new overload is added but the docs have been forgotten. |
|
Review by @som-snytt, @heathermiller, @dickwall . |
f0b54f1 to
25a22ae
Compare
The links were being skipped with a warning before this commit. The key change was to remove the result type and add an asterisk.
25a22ae to
17450e7
Compare
|
/nothingtoseehere (integrate-ide failure is unrelated to the PR) |
|
@VladUreche maybe you could review? |
|
I was scared off by the "works and warnings" table. And maybe by "remove the result type and add an asterisk." |
|
imagine if Scabot would just diff the generated HTML for us poor reviewers... |
|
@som-snytt When I was back there, in that half remembered classroom, I was always told to show my working... |
|
LGTM, thanks @janekdb! Having a tutorial for links would be greatly beneficial, based on your experiments. Would you be interested in preparing one for docs.scala-lang.org? I can help out with comments and insights.
What is Test 3? Can you file a bug? Regarding your latest comment, crashing when multiple overloads are found, you can aways switch from a warning to an error by changing these lines. |
|
@VladUreche, please disregard Test 3. It was a test I did and promptly mislaid the outcome. It's not important. Good idea regarding a tutorial. I've added it to my list, sitting somewhere down from the top but definitely a contender for some attention in Q1! |
Awesome, thanks @janekdb! I have some older write-up on links and diagrams which never made it anywhere unfortunately. If you want, I can look it up and send it to you. |
Fix Scaladoc overloaded method link to Duration companion object
|
thanks Janek, appreciated as always! |
|
@VladUreche, instead of direct comms to me please add links as comments on scala/scala-lang#394. Thanks! |
The links were being skipped with a warning before this commit.
The key change was to remove the result type and add an asterisk.