Fix report for documented data classes property #2530
Merged
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
A documented property should not be reported as undocumented by the UndocumentedPublicProperty rule. This closes #2529
BraisGabin
reviewed
Mar 27, 2020
| * @property a int1 | ||
| * [b] int2 | ||
| * @property [c] int3 | ||
| * @param d int4 |
There was a problem hiding this comment.
If dis just documented as parameter... we should flag it, right? I mean, we want to document the properties.
And probably it would be better to split this test in 4.
There was a problem hiding this comment.
As always, thanks for the review. Please see my comment regarding @param in the referenced issue.
#2529 (comment)
Splitting the test case up makes sense.
BraisGabin
approved these changes
Mar 27, 2020
arturbosch
approved these changes
Mar 28, 2020
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.
A documented property should not be reported as undocumented by the UndocumentedPublicProperty rule.
This closes #2529