Diagram spec: document the master-part entity cluster
メンテナーはふだん 3 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR（30日）
- 20
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
-
documentation good first issue hacktoberfest help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
libredb/libredb-studio#1756 ·
メンテナーはふだん 1 日以内に返信
-
docs(skills): issue-first should reference an existing Linear ticket instead of filing a duplicateオープンdocumentation
難易度 1/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
area: docs good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
メンテナーはふだん 1 日以内に返信
-
Statuslist example's pass-through compressor makes the card checker read every entry as revokedオープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
decentralized-identity/kya-os-mcp#254 ·
メンテナーはふだん 1 日以内に返信