Fix: Validation for API link #17099
Merged
Fix: Validation for API link #17099
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
ckipp01 reviewed Mar 15, 2023
There was a problem hiding this comment.
Thanks for the PR @Dedelweiss. I added a comment in the original issue. It might be good to discuss there a bit first just to ensure we're all on the same page first before digging in.
…we trigger or not the warning
Florian3k approved these changes Jun 9, 2023
nicolasstucki added a commit that referenced this pull request Aug 30, 2023
This PR combines #17099 changes with previous link resolver, which fixes #18285, #18444 and brings down `Unable to resolve link` warnings from 81 to 7. 4 more links are fixed manually in `.md` files, which leaves us with 3 warnings. Those 3 are references to source code inside `scaladoc.md`: https://github.com/lampepfl/dotty/blob/45f633d0667c702fa75efcfda91b434bb72f04dc/docs/_docs/contributing/scaladoc.md?plain=1#L77-L87 Those won't work online anyway (unless we link to github), so we might want change them.
Kordyjan pushed a commit that referenced this pull request Nov 17, 2023
In this PR: I change the regular path from `../exception/scala/Foo.html` to `exception.scala.Foo` to use the DRI resolver function. ## Context: I have a Hello World project with a `Foo` class and a `Foo2` object within a package `exception.scala` <img width="225" alt="Screenshot 2023-06-07 at 12 45 47" src="https://github.com/lampepfl/dotty/assets/44496264/1d155f81-5910-44b4-be0c-b495cd75e597"> ### Example 1 (No warning): <img width="500" alt="Screenshot 2023-06-07 at 15 38 07" src="https://github.com/lampepfl/dotty/assets/44496264/cf341967-8743-480a-9f35-7c27ed78a691"> ### Result: <img width="800" alt="Screenshot 2023-06-07 at 12 50 13" src="https://github.com/lampepfl/dotty/assets/44496264/ccea1646-3501-4ad2-b9d0-ee5d8bbac969"> As you can see, as expected there is no warning for these links. ### Example 2 (Warnings): <img width="500" alt="Screenshot 2023-06-07 at 15 41 00" src="https://github.com/lampepfl/dotty/assets/44496264/9309a851-24d6-472e-839e-444c0dc58bb6"> ### Result: <img width="800" alt="Screenshot 2023-06-07 at 15 41 13" src="https://github.com/lampepfl/dotty/assets/44496264/1b8986f9-d06c-4eda-9599-e4f2cc0343f7"> Fixes: #16695 [Cherry-picked 2d9eb1c]
Kordyjan added a commit that referenced this pull request Nov 21, 2023
Backports #17099 to the LTS branch. PR submitted by the release tooling. [skip ci]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
In this PR:
I change the regular path from
../exception/scala/Foo.htmltoexception.scala.Footo use the DRI resolver function.Context:
I have a Hello World project with a
Fooclass and aFoo2object within a packageexception.scalaExample 1 (No warning):
Result:
Example 2 (Warnings):
Result:
Fixes: #16695