PaperMC / PaperMC/adventure

Incorrect Formatter javadoc

Open
#960 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
887
Forks
160
PR merge metrics
No merged PRs in 30d

Description

It says in the javadoc that "this replacement is auto-closing, so its style will not influence the style of following components."
However, the implementations use Tag.inserting instead of Tag.selfClosingInserting, so it isn't auto-closed and the style continues into following components.
I would PR but I don't know if this is a typo or a design mistake

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Formatter javadoc and the implementations that use Tag.inserting, then compare them with Tag.selfClosingInserting. First determine whether the javadoc or the implementation reflects the intended behavior; done means the documented behavior and implementation agree, with any relevant coverage updated if it exists.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.