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

オープン 初心者向け
#784 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
68/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
java
領域
documentation

調査の方向性

catchupTicks 設定のドキュメントを見つけ、issue に示されている動作と照らし合わせて現在の説明を読みます。1 に設定すると 0 と同等になること、または 2 が実質的に有効になる最小値であることをユーザーが理解できるように文言を更新します。この区別が明示されれば、ドキュメントは完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
MDX
スター
73
フォーク
280
平均マージ
16時間 42分
マージ済み PR（30日）
5

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

PaperMC/docs のほかの issue

PaperMC/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。