Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

glossary.md's "Operator" entry only covers PD scheduling; execution-plan "operator" is undocumented and possibly ambiguous

Aperta
  • Qualcosa non va?
#23,595 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
sql
Ambito
databases, documentation

Direzione di ricerca

Inizia da glossary.md, quindi confronta la voce Operator con l'uso di operator in partitioned-table.md e nelle pagine relative a EXPLAIN. Traccia entrambi i significati e verifica se la documentazione esistente li distingue. Il lavoro è completo quando si ottiene uno tra: un chiaro rimando incrociato nel glossario o una disambiguazione per gli operatori dei piani di esecuzione, oppure una decisione registrata secondo cui il termine condiviso è intenzionale.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
615
Fork
724
Merge medio
2g 4h
PR unite (30g)
310

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pingcap/docs

Tutte le issue di pingcap/docs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.