typetools / typetools/checker-framework
Make `@FormatMethod` applicable to more methods
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 440
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 134
Description
The @FormatMethod annotation is applicable only to methods with the exact same signature as
Formatter.format: either (String, Object...) or (Locale, String, Object...).
This is a feature request to make it applicable to any method whose last two formal parameters have types String, Object....
Related: #2584
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the @FormatMethod annotation and the Formatter.format API linked in the issue, then trace the Checker Framework code and tests that enforce the current exact-signature restriction. Done means methods whose last two formal parameters are String and Object... are accepted, including the existing Formatter-like signatures, with tests covering the expanded applicability.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100