palantir / palantir/palantir-java-format
Try to not split inline tags in javadoc formatter
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 907
- Forks
- 101
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 19
Description
I tend to optimize around putting the entire tag on a single line. Splitting on the space is as reasonable as anything, but I would prefer to avoid breaking them even if it leaves shorter lines before/after.
Sorry I missed your comment when you posted it!
Originally posted by @carterkozak in https://github.com/palantir/gradle-consistent-versions/pull/283
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
The request concerns the javadoc formatter and how it wraps inline tags. No source file, test, or entry point is named, so first locate the formatter logic and its existing javadoc-formatting tests. Done means inline tags remain unsplit, even when this leaves shorter surrounding lines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100