fix(#16610): warn ignored Scaladoc on multiple enum cases #19555
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before this commit, the compiler ignored Scaladoc comment on multiple enum cases without warning. This is partly expected because the case to which the doc is attached is ambiguous, but we should at least warn users that the comment is ignored by compiler due to ambiguity and they should take an action if they want the doc to be displayed.
i10416
force-pushed
the
fix/16610-compiler-ignored-ambiguous-docs-on-enum-cases-without-warn
branch
from
5c252cb
to
76ee412
Compare
i10416
changed the title
i10416
changed the title
…on-enum-cases-without-warn
|
@Florian3k would you be kind enough to review the changes? |
|
Hi, sorry for the delay, I've somehow missed the notification. I'll get to this ASAP. |
|
This looks good, but to add new warning without flag we need to wait for 3.5.0. |
I haven't tried yet, so I'm not sure, but may I try it? |
…on-enum-cases-without-warn
> to add new warning without flag we need to wait for 3.5.0. See scala#19555 (comment)
WojciechMazur
added a commit
that referenced
this pull request
Jul 2, 2024
close #16610 Before this commit, the compiler ignored Scaladoc comment on multiple enum cases without warning. This is partly expected because the case to which the doc is attached is ambiguous, but we should at least warn users that the comment is ignored by compiler due to ambiguity and they should take an action if they want the doc to be displayed. [Cherry-picked 11a6f0a][modified]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
close #16610
Before this commit, the compiler ignored Scaladoc comment on multiple enum cases without warning.
This is partly expected because the case to which the doc is attached is ambiguous, but we should at least warn users that the comment is ignored by compiler due to ambiguity and they should take an action if they want the doc to be displayed.