Skip to content

Scaladoc: Fix problems with documenting scala.js projects #12364

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

Merged
merged 1 commit into from
May 10, 2021

Conversation

pikinier20
Copy link
Contributor

Will work after sbt release with #6499
closes: #12298

@pikinier20 pikinier20 requested review from smarter and romanowski May 7, 2021 10:12
.partition(commonScalaSettings.contains)
shared.foreach(setInGlobal)

if !other.isEmpty then report.echo(s"Skipping unused scalacOptions: ${other.map(_.name).mkString(", ")}")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If sbt automatically passes these options to scaladoc, then we shouldn't display this message to the user since they can't do anything about it, so it would just be noise.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought that it's nice to inform (instead of warn) an user that these options were passed to scaladoc but are unused. Doing it silentely might be confusing when someone adds compile options by:

Compile / doc / scalacOptions ++= ...

And won't know why they are not working. What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we could distinguish which options were user-defined and which were just copied from Compile / scalacOptions that would be nice indeed, but as it is I'm not sure.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should print this message using the info or debug level since in most cases this will be noise but in few rare cases, this may save quite a lot of debugging.

@pikinier20 pikinier20 merged commit 62f202b into master May 10, 2021
@pikinier20 pikinier20 deleted the scaladoc/scalajs-fix branch May 10, 2021 08:08
@Kordyjan Kordyjan added this to the 3.0.1 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Scaladoc: Doctool doesn't include -scalajs flag to compile TASTY files of JSProject
4 participants