forked from EduCraft/curriculum-project-hub
sjfhsjfh
73e9d258d6
按新文风(简洁书面中文)重写 spec/ 全部 Lean doc 注释、spec/README, 并顺根 README。核心:讲清产品逻辑、去伪术语、去 ADR 黑话、DRY。 语言:砍钉死/留痕/实现侧/将就/脑补/刻意等伪术语;短句;不复述文件系统 能看到的东西;typst 考据移出 spec 指向 ADR。 内容取舍(动结构): - System 层大改:删 can_mono 形式化定理、Capability 9 项枚举与 requiredRole 映射、RunState 6 构造子;Audit.lean 删除并入 System 顶部。 Hub 未建的部分一律 prose 占位,只留 Lock 的 owner=run 与 WellFormed。 - 澄清两个"检查":产品 checker(LLM 判不了合法性,checker 真跑工具补这块) vs 开发时 spec↔impl 一致性检查(无自动闸门)。Oracle 重新定位为 "checker 得委托外部工具才能判的事实",不是"Lean 没写形式化"。 - spec/README 补取舍判据 checklist(自顶向下逐步细化、不在 Lean 里验证实现)。 - 根 README 去 DRY:删硬编码版本号、cache 路径细节;宪法第 3 条吸收 "人/coding assistant 核对"修正;第 5 条与 spec/README 判据去重。 保留:Export/Render 执行语义、Info 的 raw→canonical 设计模式(产品语义, 只顺文风不砍结构);renderIgnoredSeverity(实现对齐依赖)。 lake build 通过(24 jobs)。 Co-Authored-By: Claude <noreply@anthropic.com>
57 lines
2.7 KiB
Lean4
57 lines
2.7 KiB
Lean4
/-!
|
|
# Info —— 课时元信息:canonical 模型 vs 撰写态
|
|
|
|
`[info]`(标题、作者)大多是 passthrough 元数据(ADR-0008),本不入契约。但作者的
|
|
基数是一个真分歧点:一节课可由多人(教研组)署名,故 canonical 模型里 author 是一个
|
|
有序列表,不是单值或可选单值。
|
|
|
|
另有一条值得钉的模式:on-disk 的撰写态(用户实际填写的形态)是语法糖——单作者可写
|
|
`author = "…"`,多作者写 `author = ["…", "…"]`——但这个"字符串或数组"的二态只活在
|
|
加载边界:`RawInfo` 经归一化折叠成 canonical `Info`,其后不再出现。canonical 接收端
|
|
始终是 `List String`,raw 形式不泄漏进模型其余部分。这正是 `Info`(canonical)与
|
|
`RawInfo`(撰写态)两个结构存在的理由。
|
|
-/
|
|
|
|
namespace Spec.Courseware
|
|
|
|
/-- 作者的撰写态形式(ADR-0008)。on-disk 单作者可写裸字符串、多作者写数组——填写便利,
|
|
非语义分歧。此 union 只活在加载边界,经 `RawAuthor.normalize` 折叠后不再出现。 -/
|
|
inductive RawAuthor where
|
|
/-- 单作者裸字符串 `author = "…"`。 -/
|
|
| one (name : String)
|
|
/-- 多作者数组 `author = ["…", "…"]`。 -/
|
|
| many (names : List String)
|
|
|
|
/-- raw 作者归一化为有序作者列表(ADR-0008)。单作者 ⇒ 单元素列表;数组 ⇒ 原样。
|
|
这条钉"canonical 接收端始终是 `List String`"。 -/
|
|
def RawAuthor.normalize : RawAuthor → List String
|
|
| .one n => [n]
|
|
| .many ns => ns
|
|
|
|
/-- 课时元信息的 canonical 模型(ADR-0008)。`authors` 是有序列表:多人署名第一类,
|
|
空列表 = 未署名。`title` 等其余字段是 passthrough 元数据,不在此承诺更多。这是系统
|
|
其余部分唯一所见的形态——author 在此已是列表,不再是"字符串或数组"。 -/
|
|
structure Info where
|
|
/-- 标题(passthrough 元数据)。 -/
|
|
title : String
|
|
/-- 作者有序列表(空 = 未署名)。canonical 始终是列表。 -/
|
|
authors : List String
|
|
|
|
/-- 撰写态的 `[info]`(ADR-0008)。`author` 用 `RawAuthor`(字符串或数组),缺省即未署名。
|
|
此结构刻画"为便于填写而存在的 raw 形态",不是模型其余部分流通的形式——它经
|
|
`RawInfo.toInfo` 归一化为 canonical `Info`。 -/
|
|
structure RawInfo where
|
|
/-- 标题。 -/
|
|
title : String
|
|
/-- 作者 raw 形式(可选;缺省即未署名)。 -/
|
|
author : Option RawAuthor
|
|
|
|
/-- raw `[info]` 归一化为 canonical `Info`(ADR-0008)。缺省 author ⇒ 空列表,否则按
|
|
`RawAuthor.normalize`。raw 的"字符串或数组"二态在此被消解,不泄漏进 `Info`——
|
|
canonical 接收端恒为 `List String`。 -/
|
|
def RawInfo.toInfo (r : RawInfo) : Info :=
|
|
{ title := r.title
|
|
authors := (r.author.map RawAuthor.normalize).getD [] }
|
|
|
|
end Spec.Courseware
|