Mention that catchupTicks set to 1 are equivalent to set to 0 (disabled)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- java
- Domain
- documentation
Research direction
Locate the documentation for the catchupTicks configuration and read its current description alongside the behavior shown in the issue. Update the wording so users understand that setting it to 1 is equivalent to 0, or that 2 is the minimum effective enabled value; the documentation is done when this distinction is explicit.
Written by the indexing model from the issue text.
Description
I mean, overall I initially expected the behavior to be
final long catchup = 1L + io.papermc.paper.configuration.GlobalConfiguration.get().misc.catchupTicks.or(4);
instead of
final long catchup = (long)Math.max(
1,
io.papermc.paper.configuration.GlobalConfiguration.get().misc.catchupTicks.or(5)
);
when I first saw that option. That said, if this is the intended behavior, it would be good to document that the minimum effective enabled value is 2, or at least mention that setting it to 1 is equivalent to 0.
Also, if 0 is meant to represent disabled, it's fairly intuitive to expect 1 to be the minimum enabled value. A user might intentionally configure it to 1 because they want the smallest possible non-disabled setting, so having it behave the same as 0 is somewhat surprising unless it's explicitly documented.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 16h 42m
- Merged PRs (30d)
- 5
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.
More from PaperMC/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
dev guide project: Paper
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
Similar issues
-
Link Checker Report Openautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Humanity AI Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
numfocus/project-fundraising#166 ·
-
area:proxy bug security severity:low track:open-source
Difficulty 2/5 1-3 hours Newbie friendliness 70/100