Fix inherit doc warnings #13199
Merged
Fix inherit doc warnings #13199
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
KacperFKorban
approved these changes
Jul 29, 2021
griggt
reviewed
Jul 29, 2021
| @@ -79,7 +79,7 @@ class CommentExpander { | |||
| case None => | |||
| // SI-8210 - The warning would be false negative when this symbol is a setter | |||
| if (ownComment.indexOf("@inheritdoc") != -1 && ! sym.isSetter) | |||
| println(s"${sym.span}: the comment for ${sym} contains @inheritdoc, but no parent comment is available to inherit from.") | |||
| report.warning(s"${sym.span}: the comment for ${sym} contains @inheritdoc, but no parent comment is available to inherit from.", sym.srcPos) | |||
There was a problem hiding this comment.
Is it still useful to include ${sym.span} in the message now that report.warning is used with sym.srcPos? The message may be confusing to the user who may not understand what those numbers mean?
-- Warning: scaladoc-testcases/src/tests/inheritDoc.scala:6:6 ------------------
6 | def f: Unit = { }
| ^
|<76..76>: the comment for method f contains @inheritdoc, but no parent comment is available to inherit from.
There was a problem hiding this comment.
You may be right. I didn't change the message, just the way it's sent, but probably we should remove span there.
pikinier20
force-pushed
the
scaladoc/inherit-doc-warning
branch
from
f27ba98
to
a77f23e
Compare
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.
closes #13068