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

Diagram spec: document the master-part entity cluster

Abierto
  • ¿Algo no está bien?
#298 0 comentarios 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
1-2 días
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown, python
Área
documentation

Línea de trabajo

Start with the "Schema Grouping" section of reference/specs/diagram.md and the Edge Styles section, then read the master-part grouping logic in datajoint-python's diagram.py (the entity_fill values and part labelling). Add a "Master-part grouping" section covering the unlabeled group, part labels, rank layout, and edge weight, with one figure and a link to master-part.md. Done when the four points are explained, the figure renders, and the link resolves.

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

Descripción

Summary

reference/specs/diagram.md documents the tier shapes, the edge styles, the underline, and schema grouping, but not the master-part entity cluster that dj.Diagram has drawn since the 2.3 notation work (datajoint-python #1532 / #1534). A reader of the spec cannot learn why parts sit in a shaded group, why a part's label lacks its master's name, or how the group is laid out. These are the questions people ask when they meet the group in a figure.

What the renderer does (datajoint-python diagram.py)

  • Grouping. Within a schema cluster, a master and its visible parts are enclosed in a nested, unlabeled cluster with a fill (entity_fill: #F3F5F8 light, #2A313D dark) and no border. Edges are drawn over it.
  • Part labels. Inside the group, a part shows its own name only (Scan, not Acquisition.Scan), because the group carries the membership. A part shown without its master is labeled Master.Part.
  • Layout. The master and its parts share a rank, so the horizontal reads as derivation and the vertical as containment. The exception is a part that depends on a sibling part, which is left off the rank so the chain within the group descends.
  • Edges. A master→part edge follows the ordinary weight rule. A part almost always adds a key attribute, so the edge is thin (the spec says this under Edge Styles). The part is underlined when it introduces a dimension.

Proposed addition

A short "Master-part grouping" section after "Schema Grouping", covering the four points above. It should include one figure from a schema with a master and two parts, one of which depends on a sibling, and link to master-part.md for the semantics (one entity spread over rows, inserted in one transaction, deleted together).

Related: #299 (the master-part spec side), #249 (diagram-traversal algebra in the same spec, including the master↔part group rule for restriction).

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.