Skip to content
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.

Sign up for GitHub

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

Jump to bottom

scaladoc -no-link-warnings does not work #16694

Closed
alanbur opened this issue Jan 14, 2023 · 1 comment · Fixed by #17028
Closed

scaladoc -no-link-warnings does not work #16694

alanbur opened this issue Jan 14, 2023 · 1 comment · Fixed by #17028
Labels
area:doctool itype:bug Spree Suitable for a future Spree
Milestone
3.4.0

Comments

@alanbur
Copy link

alanbur commented Jan 14, 2023

Scaladoc version 3.2.1 -- Copyright 2002-2022, LAMP/EPFL

If the --no-link-warnings flag is used, it does not suppress link warnings,

[warn] -- Warning: static_site/_docs/index.md -----------------------------------------
[warn] /home/foo/static_site/_docs/index.md: Unable to resolve link '../foo/bar/SomeClass.html
@alanbur alanbur added itype:bug stat:needs triage Every issue needs to have an "area" and "itype" label labels Jan 14, 2023
@KacperFKorban KacperFKorban added area:doctool and removed stat:needs triage Every issue needs to have an "area" and "itype" label labels Jan 14, 2023
@SethTisue SethTisue added the Spree Suitable for a future Spree label Jan 19, 2023
@Dedelweiss Dedelweiss mentioned this issue Mar 7, 2023
Merged
@ckipp01
Copy link
Member

ckipp01 commented Mar 30, 2023 •
edited
Loading

So I think there is a bit of confusion here. Looking at the actual description you see:

"Avoid warnings for ambiguous and incorrect links in members look up. Doesn't affect warnings for incorrect links of assets etc.",

So it's actually not meant to be applied in this way. Although the overloading here is confusing. I see that #17028 does provide a fix for this, but probably not the way we want to do this. There is a few different things we could do here:

  • Do we expand the meaning of this flag to also warn about actual dead links in assets/pages?
  • Do we introduce another new flag to silence these?

ckipp01 pushed a commit that referenced this issue Jun 20, 2023
@Dedelweiss
Fix: -no-link-warnings does not work (#17028)
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
@Kordyjan Kordyjan added this to the 3.4.0 milestone Aug 2, 2023
Kordyjan pushed a commit that referenced this issue Nov 23, 2023
@Dedelweiss @Kordyjan
Fix: -no-link-warnings does not work (#17028)
69cfa7e 
## 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]
Kordyjan pushed a commit that referenced this issue Nov 29, 2023
@Dedelweiss @Kordyjan
Fix: -no-link-warnings does not work (#17028)
3145b66 
## 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]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:doctool itype:bug Spree Suitable for a future Spree
Projects
None yet
Milestone
3.4.0
Development

Successfully merging a pull request may close this issue.

Fix: -no-link-warnings does not work Dedelweiss/dotty
5 participants
@SethTisue @alanbur @Kordyjan @ckipp01 @KacperFKorban