palantir / palantir/palantir-java-format
Incorrect line breaks on markdown comments
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 908
- Forks
- 101
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 19
Description
When a markdown comment get's formatted and a line is broken up, comment dashes (//) are used instead of the markdown dashes (///),
Input
/// This exceeds the line limit
public class Foo {...}
Expected
/// This exceeds
/// the line limit
public class Foo {...}
Actual
/// This exceeds
// the line limit
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
Start by reproducing the formatting of the Java example with a markdown comment that exceeds the line limit, then trace the formatter's handling of broken comment lines. Done means continuation lines use /// rather than //, matching the expected output shown in the issue.
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