Diagram spec: document the master-part entity cluster
维护者通常 3 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 55/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- markdown, python
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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:#F3F5F8light,#2A313Ddark) and no border. Edges are drawn over it. - Part labels. Inside the group, a part shows its own name only (
Scan, notAcquisition.Scan), because the group carries the membership. A part shown without its master is labeledMaster.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).
- 主要语言
- Jupyter Notebook
- 星标
- 7
- 派生
- 12
- 平均合并
- 2 天 19 小时
- 30 天内合并 PR
- 20
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
datajoint/datajoint-docs 的其他 Issue
-
documentation
难度 3/5 1-2 天 新手友好度 45/100
datajoint/datajoint-docs#301 ·
维护者通常 3 天内回复
-
难度 3/5 半天 新手友好度 55/100
datajoint/datajoint-docs#300 ·
维护者通常 3 天内回复
-
难度 3/5 半天 新手友好度 52/100
datajoint/datajoint-docs#299 · 1 条评论 ·
维护者通常 3 天内回复
-
documentation
难度 3/5 1-2 天 新手友好度 45/100
datajoint/datajoint-docs#292 ·
维护者通常 3 天内回复
查看 datajoint/datajoint-docs 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 75/100
RustCrypto/SSH#596 ·
-
Translation TwigBridge
难度 2/5 1-3 小时 新手友好度 68/100
symfony/symfony-docs#23308 ·
维护者通常 3 天内回复
-
sync-en
难度 1/5 1 小时以内 新手友好度 84/100
维护者通常 1 天内回复
-
sync-en
难度 1/5 1 小时以内 新手友好度 84/100
维护者通常 4 天内回复
-
Перевод устарел
难度 1/5 1 小时以内 新手友好度 88/100