Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
  • 哪里不对？
#299 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 3 天内回复

还没有人认领这个 Issue。

评估

难度
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 小时
30 天内合并 PR
20

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

datajoint/datajoint-docs 的其他 Issue

查看 datajoint/datajoint-docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。