playframework / playframework/play1

Fix Controller.shouldBeCheckedForEnhancement method name

Open
#1,271 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.6k
Forks
671
Avg merge
12d 15h
Merged PRs (30d)
1

Description

As part of the effort to support newer versions 9+ of the JDK, the method Controller.shouldBeCheckedForEnhancement() was recently added. The behavior is correct, but the name indicates the logical complement. At the very least, the name should be shouldNotBeCheckedForEnhancement(). I would suggest the name enhancementCheckComplete() .

You can see the author commented on the correct logic in the javadoc comment for the method where it reads:

and therefore should not be checked for enhancement

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate Controller.shouldBeCheckedForEnhancement() and read its Javadoc, especially the statement that the method indicates enhancement should not be checked. Decide between the proposed replacement names, rename the method, and update its references so the project still builds.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.