Separate report to clarify `OutdatedDocumentation` by atulgpt · Pull Request #9229 · detekt/detekt · GitHub
Skip to content

Separate report to clarify OutdatedDocumentation#9229

Open
atulgpt wants to merge 1 commit intodetekt:mainfrom
atulgpt:fixes/5561/improve-outdated-docs
Open

Separate report to clarify OutdatedDocumentation#9229
atulgpt wants to merge 1 commit intodetekt:mainfrom
atulgpt:fixes/5561/improve-outdated-docs

Conversation

@atulgpt
Copy link
Copy Markdown
Contributor

@atulgpt atulgpt commented Apr 6, 2026

fixes #5561

@detekt-ci detekt-ci added the rules label Apr 6, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 6, 2026

@atulgpt
Copy link
Copy Markdown
Contributor Author

atulgpt commented Apr 8, 2026

@BraisGabin @TWiStErRob can you review this PR?

Comment on lines +227 to +230
declarationNameMatches(
docItr,
elementItr,
)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
declarationNameMatches(
docItr,
elementItr,
)
declarationNameMatches(docItr, elementItr)

assertThat(subject.lint(code))
.singleElement()
.extracting { it.message }
.isEqualTo("@property a type doesn't match corresponding declaration of type param.")
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This message is a bit odd, right? Shouldn't say that private properties shouldn't be documented?

Maybe this message would be better for this case: " doesn't have corresponding public declaration."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It should be " doesn't have corresponding public declaration.", right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OutdatedDocumentation is too vague

3 participants