Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Diagram spec: document the master-part entity cluster

Đang mở
  • Có gì không ổn?
#298 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 3 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, python
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Jupyter Notebook
Star
7
Fork
12
Merge trung bình
2 ngày 19 giờ
Pull request đã merge (30 ngày)
20

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của datajoint/datajoint-docs

Tất cả issue của datajoint/datajoint-docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.