Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[apex] Updated the docs for UnusedMethod as per discussion #5200 #5354

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

sam-gearset
Copy link
Contributor

@sam-gearset sam-gearset commented Nov 21, 2024

Describe the PR

Updated the documentation for the Apex > Design > UnusedMethod rule in conjunction with this discussion around a nuance with apex-link and not finding methods in 'empty' classes unless there's a variable declaration or other method present/called.

Related issues

As above, relates to findings from discussion #5200 which was causing some unknown behaviour with the rule not firing as expected. Doesn't fix #5200 but makes it clearer in the documentation.

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@oowekyala oowekyala added the in:documentation Affects the documentation label Nov 21, 2024
@jsotuyod jsotuyod changed the title Updated the docs for UnusedMethod as per discussion #5200 [apex] Updated the docs for UnusedMethod as per discussion #5200 Nov 21, 2024
Copy link
Member

@adangel adangel left a comment

Choose a reason for hiding this comment

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

Thanks!

I'll adjust the text a bit to clarify, that this is about the entire class that might be (un)used...

@adangel adangel added this to the 7.8.0 milestone Nov 22, 2024
@adangel adangel merged commit 85b76a9 into pmd:main Nov 22, 2024
adangel added a commit that referenced this pull request Nov 22, 2024
adangel added a commit that referenced this pull request Nov 22, 2024
Merge pull request #5354 from sam-gearset:feature/PMD7-UnusedMethod-DocUpdate
@sam-gearset
Copy link
Contributor Author

Perfect, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in:documentation Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants