redhat-developer / redhat-developer/vscode-java
JavaDoc rendering does not preserve white-space in code blocks.
Open
Nobody has claimed this yet.
javadoc
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
According to everything I can find, preserving white-space in a JavaDoc should work with a code block, pre tag, or tt tag.
However, when using {@code 10/2021 - CURRENT} in a JavaDoc, the extra space is not preserved in the rendered tool-tip.
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
No source file or test is identified in the issue. Start by reproducing the JavaDoc tooltip behavior with {@code 10/2021 - CURRENT}, then trace the rendering entry point and add coverage for preserved whitespace; done means the extra space appears in the rendered tooltip.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, typescript, vscode
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 40/100