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

Master-part spec: state the dimension rule and link the diagram's grouping

Aperta
  • Qualcosa non va?
#299 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
52/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Start with reference/specs/master-part.md, reading §1 (Definition) and §3.3 (Computed Tables with Parts), and with explanation/entity-integrity.md for the dimension rule from #276. Add the "Parts carry new dimensions" subsection with the zero-items case, the two part-key patterns (new attribute versus one row per row of another table), and a link to the explanation. Done when the subsection covers all four points and the "In diagrams" note links to the diagram spec's master-part grouping, which depends on #298.

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

Descrizione

Summary

reference/specs/master-part.md specifies definition, integrity, insertion and deletion, but it says nothing about two things the rest of the documentation relies on:

  1. The dimension rule. An auto-populated master introduces new dimensions only through its parts. explanation/entity-integrity.md states it ("Autopopulated tables introduce dimensions only through part tables", from #276): a Computed or Imported table's primary key comes entirely from its dependencies, and when one make() call produces several results that each need an identifier, that identifier goes in a part table. The spec's §3.3 "Computed Tables with Parts" shows the pattern but never says why it is required. It also doesn't say what goes wrong without it: a computation that yields zero items leaves no row, so the key is recomputed on every populate(). The master row is what records that the computation ran.
  2. How a master-part group is drawn. dj.Diagram encloses a master and its parts in an unlabeled shaded group and names parts without the master prefix inside it. A reader of this spec should be able to find that, or a link to it, from here.

Proposed changes

  • In §1 (Definition) or §3.3, a short subsection, "Parts carry new dimensions". It covers:
    • the rule;
    • the zero-items case;
    • when a part's key adds an attribute (a new dimension: underlined, thin edge from the master) and when it doesn't (one row per row of another table: a thick edge from that table, not underlined, like Spectrum with one row per Scan);
    • a link to explanation/entity-integrity.md.
  • A one-paragraph "In diagrams" note linking to the diagram spec's master-part grouping (#298).

Related: #276 (the dimension rule in the explanation), #222 (master-part spec: depending on the master implies its parts).

Lingua principale
Jupyter Notebook
Stelle
7
Fork
12
Merge medio
2g 19h
PR unite (30g)
20

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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 datajoint/datajoint-docs

Tutte le issue di datajoint/datajoint-docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.