glossary.md's "Operator" entry only covers PD scheduling; execution-plan "operator" is undocumented and possibly ambiguous
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- sql
調査の方向性
glossary.md から始め、partitioned-table.md および EXPLAIN 関連のページでの operator の使用と Operator の項目を比較します。両方の意味を追跡し、既存のドキュメントでそれらが区別されているか確認します。完了条件は、明確な用語集の相互参照、実行計画の operator に対する曖昧さの解消、または共有された用語が意図的なものであるという記録された判断のいずれかです。
索引モデルが issue の本文から書いたものです。
説明
What did you do?
While reviewing Japanese translation consistency for the term "operator" (see https://github.com/pingcap/docs/pull/23594), I found that glossary.md defines "Operator" strictly as a PD scheduling concept:
Operator
An operator is a collection of actions that applies to a Region for scheduling purposes. Operators perform scheduling tasks such as "migrate the leader of Region 2 to Store 5" and "migrate replicas of Region 2 to Store 1, 4, 5".
An operator can be computed and generated by a scheduler, or created by an external API.
However, the bare word "operator" is also used elsewhere in the docs for a completely different concept — a node/step in a query execution plan (e.g. TableScan, HashAgg, Exchange, IndexLookUp), for example in partitioned-table.md ("each operator supports direct access to multiple partitions") and throughout the EXPLAIN-related pages. This second sense has no glossary entry of its own and is not distinguished from the PD-scheduling sense anywhere in the docs.
What did you expect to see?
Either:
- A separate glossary entry (or a disambiguation note on the existing "Operator" entry) for the execution-plan sense of "operator", so readers landing on the glossary from an EXPLAIN-related page aren't given an unrelated PD-scheduling definition, or
- Confirmation that this overlap is intentional/acceptable, so translation teams (and future doc edits) know to keep treating both senses as the same term rather than trying to disambiguate them.
What did you see instead?
A single "Operator" glossary entry that only documents one of (at least) two distinct technical meanings the word carries elsewhere in the docs, with no cross-reference or disambiguation between them.
Additional context
This surfaced while normalizing the Japanese translation's katakana spelling for "operator" (オペレータ → オペレーター) across both PD-scheduling and execution-plan contexts. Since the English source itself doesn't distinguish the two senses, the Japanese translation currently mirrors that (uses the same term for both) — but it would help future translation/editing work to have an explicit answer on whether that's the intended approach.
- 主要言語
- Python
- スター
- 615
- フォーク
- 724
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 310
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pingcap/docs のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
Broken Link Detectedオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
Broken Link Detectedオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 63/100
GAM-team/got-your-back#547 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
UKGovernmentBEIS/inspect_ai#5821 ·
メンテナーはふだん 1 日以内に返信
-
docs help wanted
難易度 1/5 1〜3時間 初心者へのやさしさ 75/100
-
evidence wanted good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
open-coder-ai/agentseam#195 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信