Skip to content

Multiple -d in scaladoc #12968

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

Closed
BarkingBad opened this issue Jun 28, 2021 · 5 comments · Fixed by #13004
Closed

Multiple -d in scaladoc #12968

BarkingBad opened this issue Jun 28, 2021 · 5 comments · Fixed by #13004

Comments

@BarkingBad
Copy link
Contributor

Passing -d flag makes scaladoc throw warning about -d set multiple times. Probably comes from default values passed from sbt

@SethTisue
Copy link
Member

It isn't clear to me this qualifies as a bug. sbt doesn't expect the user to pass -d directly; rather, it expects the user to customize Compile / doc / target.

(Also, wondering: is this any different than the Scala 2 behavior?)

@vincenzobaz
Copy link
Contributor

Hi @SethTisue, @BarkingBad is helping me with a scaladoc tutorial and example setup and I complained about this warning.
I used the -d flag instead of Compile / doc / target because it is shown in the documentation, here.

So probably this is a documentation bug rather than an implementation one :)

@BarkingBad
Copy link
Contributor Author

Thanks Seth, you pointed me to the root of the problem I think.
This is the line where is aggregated target value and scalacOptions value

The question is, if one wants to put the docs in the separate directory different than target/api and pass the -d option to the scalacOptions should we hide the warning for that option, or leave it as a reminder that one is overriding the target default one

@dwijnand
Copy link
Member

The point is that if one wants that they should redefine Compile / doc / target, not pass the -d option. So I think there's no behavioural change to do here - but perhaps that doc page can make that clearer.

@BarkingBad
Copy link
Contributor Author

Yeah, I will update the docs then

@Kordyjan Kordyjan added this to the 3.1.0 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants