palantir / palantir/palantir-java-format
Imports for markdown comments get removed
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 907
- Forks
- 101
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 19
Description
Imports that are solely used in markdown comments are wrongly claimed as unused and thus are being removed
Input
import com.acme.Example;
/// This is an [Example]
public class Foo {...}
Expected
no changes
Actual
/// This is an [Example]
^^^^ missing reference
public class Foo {...}
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
Reproduce the Java example from the issue and trace the unused-import handling that removes com.acme.Example. No source file or test is named, so first locate the relevant formatter or import-analysis entry point. Done means the import remains unchanged when its only reference is in a markdown comment.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100