PaperMC / PaperMC/docs

Mention that catchupTicks set to 1 are equivalent to set to 0 (disabled)

Open Beginner friendly
#784 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
73
Forks
280
Avg merge
20h 52m
Merged PRs (30d)
4

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.

Contributor guide

Open the contributing guide

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 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.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.