-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix: -no-link-warnings does not work #17028
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the pr @Dedelweiss!
So I'm not convinced that changing the value is worth it here since this would in theory be a breaking change for scaladoc or for people using this value already.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @Dedelweiss are you able to squash these commits and update the PR description as it's out of date now.
I took a bit of time and dug a bit deeper into what was going on here @Dedelweiss and I think there is a small misunderstanding. I explained further in #16694 (comment). We'll need to discuss how we proceed there first. |
Change spelling of noLinkWarning Correct test Correction and add condition for noLinkWarning Correction Correction Correction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. @Dedelweiss we'll probably want to document this somewhere. Maybe a draft pr in the scala lang site that we can merge once this is released?
## Goal There are two purposes to this PR, the first is to add warning suppression when the path to the file is inneficient and a warning suppression flag is set. The second one is to deprecate the current flag and introduce a new to avoid the ambiguity. One for dead links with the current meaning, and one with dead links in assets. The goal is to avoid the confusion with overloading of the naming. I wonder if I also change the name of the previous flag to be more precise in its use. ## Flags noLinkWarnings - Boolean "-no-link-warnings", "Avoid warnings for ambiguous and incorrect links in members look up. Doesn't affect warnings for incorrect links of assets etc." noLinkAssetWarnings - Boolean "-no-link-asset-warnings", "Avoid warnings for incorrect links of assets like images, static pages, etc.", false ## Before : <img width="700" alt="Screenshot 2023-03-13 at 16 25 03" src="https://user-images.githubusercontent.com/44496264/224748941-65f08ba5-0498-4a0c-82b4-38b3921fcddd.png"> ## After : <img width="700" alt="Screenshot 2023-03-13 at 16 28 02" src="https://user-images.githubusercontent.com/44496264/224748976-dcd1825b-e4e7-48b4-b093-cc4f86a78fb0.png"> Fixes #16694 [Cherry-picked be70d46]
## Goal There are two purposes to this PR, the first is to add warning suppression when the path to the file is inneficient and a warning suppression flag is set. The second one is to deprecate the current flag and introduce a new to avoid the ambiguity. One for dead links with the current meaning, and one with dead links in assets. The goal is to avoid the confusion with overloading of the naming. I wonder if I also change the name of the previous flag to be more precise in its use. ## Flags noLinkWarnings - Boolean "-no-link-warnings", "Avoid warnings for ambiguous and incorrect links in members look up. Doesn't affect warnings for incorrect links of assets etc." noLinkAssetWarnings - Boolean "-no-link-asset-warnings", "Avoid warnings for incorrect links of assets like images, static pages, etc.", false ## Before : <img width="700" alt="Screenshot 2023-03-13 at 16 25 03" src="https://user-images.githubusercontent.com/44496264/224748941-65f08ba5-0498-4a0c-82b4-38b3921fcddd.png"> ## After : <img width="700" alt="Screenshot 2023-03-13 at 16 28 02" src="https://user-images.githubusercontent.com/44496264/224748976-dcd1825b-e4e7-48b4-b093-cc4f86a78fb0.png"> Fixes #16694 [Cherry-picked be70d46]
Backports #17028 to the LTS branch. PR submitted by the release tooling. [skip ci]
Goal
There are two purposes to this PR, the first is to add warning suppression when the path to the file is inneficient and a warning suppression flag is set.
The second one is to deprecate the current flag and introduce a new to avoid the ambiguity. One for dead links with the current meaning, and one with dead links in assets. The goal is to avoid the confusion with overloading of the naming.
I wonder if I also change the name of the previous flag to be more precise in its use.
Flags
noLinkWarnings - Boolean
"-no-link-warnings",
"Avoid warnings for ambiguous and incorrect links in members look up. Doesn't affect warnings for incorrect links of assets etc."
noLinkAssetWarnings - Boolean
"-no-link-asset-warnings",
"Avoid warnings for incorrect links of assets like images, static pages, etc.",
false
Before :
After :
Fixes #16694