Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#299 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
52/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Jupyter Notebook
Estrellas
7
Forks
12
Merge medio
2 d 19 h
PR fusionados (30 d)
20

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de datajoint/datajoint-docs

Todos los issues de datajoint/datajoint-docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.