Skip to content

Conversation

isomarcte
Copy link
Member

They are not fatal and we've since cleaned up most of them. It is our hope that by enabling them we can catch simple typos, etc.

For context, see: #4020 (comment)

They are not fatal and we've since cleaned up _most_ of them. It is our hope that by enabling them we can catch simple typos, etc.
@isomarcte isomarcte force-pushed the enable-scaladoc-linking-warnings branch from 5a91422 to 4f77b5c Compare December 17, 2020 17:56
@isomarcte
Copy link
Member Author

Oh that's odd. They weren't fatal when I ran them locally...I'll look into this.

@rossabaker
Copy link
Member

sbt-spiewak makes them fatal on CI, but not locally. This is convenient when exploring and having unused imports, but it's frustrating when it comes PR time. I'm not sure I like the behavior, and we can turn it off, but that's why, and it's a recent change.

@isomarcte
Copy link
Member Author

@rossabaker ah, that makes sense. I was grepping for a -Werror or -Xfatal-warnings I'd thought I'd missed.

I would be fine disabling that in CI. For just about all scopes other than docs I do want -Werror, but docs is the exception.

This reverts commit 206f320.

The warnings were being made fatal by the sbt-spiewak plugin, not directly in the build.
@rossabaker
Copy link
Member

My attention has been split and there are a lot of exemptions floating around in a lot of plugins and I guess I need a mental reset.

So as of be0890c, we have several linking warnings. These are fatal in CI. Can we clean these up and leave the flags as they are? Sometimes I try to do too many things at once and rely on CI to alert me about broken docs, so I have a mild preference for leaving them on so they're seen as they happen. But they can be annoying -- last time I tried, we couldn't run mdoc cleanly on 2.13, which is why we just generate them from 2.12.

I'm pretty open to whatever solution you think is best here.

@isomarcte
Copy link
Member Author

@rossabaker the remaining warnings are all related to overloaded symbols. I would love to clean them up, but for the life of me I can't seem to get the correct incantation. You are supposed to be able to provide part of the signature to distinguish between overloaded symbols, but nothing I tried seemed to work.

I'll attempt to another crack at it before we change the warning flags.

@rossabaker
Copy link
Member

An unsatisfying solution, if all else fails, is also to just unlink them.

@isomarcte
Copy link
Member Author

isomarcte commented Dec 18, 2020

@rossabaker

An unsatisfying solution, if all else fails, is also to just unlink them.

I'd be hesitant to do that in this case. When there is an overloaded symbol in a Scaladoc link, Scaladoc will still generate a link to one of the members (I assume it just picks one at random), it just also emits a warning. So, from a user's perspective, they are still getting the nice linking. It's just a pain in the build.

@rossabaker
Copy link
Member

Ah, that makes sense. Could we turn off fatal warnings for doc and unidoc, but leave them on for compiling and mdoc?

@rossabaker rossabaker added the docs Relates to our website or tutorials label Apr 12, 2021
@armanbilge armanbilge closed this May 1, 2022
@armanbilge armanbilge reopened this May 1, 2022
@armanbilge armanbilge changed the base branch from series/0.21 to series/0.23 May 1, 2022 21:00
@armanbilge armanbilge closed this May 1, 2022
@armanbilge armanbilge reopened this May 1, 2022
@mergify mergify bot added the series/0.23 PRs targeting 0.23.x label May 1, 2022
@armanbilge armanbilge force-pushed the enable-scaladoc-linking-warnings branch from ac069b1 to 6f890a4 Compare May 1, 2022 21:07
@armanbilge
Copy link
Member

I'd like to land this one. It's also currently affected by typelevel/sbt-typelevel#226 I believe.

@armanbilge armanbilge added the behind-the-scenes Appreciated, but not user-facing label Jun 3, 2022
@armanbilge armanbilge merged commit 499846c into http4s:series/0.23 Jun 3, 2022
@armanbilge armanbilge mentioned this pull request Jul 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
behind-the-scenes Appreciated, but not user-facing docs Relates to our website or tutorials module:circe module:client module:core module:server series/0.23 PRs targeting 0.23.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants