Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
  • 何か問題がありますか？
#299 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 3 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
半日
初心者へのやさしさ
52/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Jupyter Notebook
スター
7
フォーク
12
平均マージ
2日 19時間
マージ済み PR（30日）
20

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

datajoint/datajoint-docs のほかの issue

datajoint/datajoint-docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。