Files
marqdo/doc/design/return-hr-and-code-surface.md
cflmyandCursor 5e74ff39f2 feat(markup): code-as-docs narration surface (G1–G4) and drop --- body end
Treat --- as Markdown HR everywhere, end side-effect helpers with empty returns,
and accept soft emphasis, float literals, and dynamic footnote keys so LLM-friendly
.mq.md stays runnable. Ship the weekend coffee example plus gold fixtures.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-14 10:16:48 +08:00

1.8 KiB
Raw Permalink Blame History

记录:返回 / 语句 / 输出 / 分割线(决议)

状态 v0.2 已决议(现行实现);v0.3 拟对调 * / ** 角色(见下)
日期 2026-08-04
修订 2026-09-13:挂接 markdown-mapping-v0.3.md

决议(v0.2 · 现行)

  1. *…* = 程序语句。
  2. **…** = 返回值(架构级);空粗体 **** / ** ** = 空返回(None)并结束函数体。
  3. 输出用内置函数 print(英文),不是粗体,不是中文名。
  4. --- / ***:Markdown 叙述分隔(跳过);不再结束函数体。无值收束用 *None* / 整行 ** / ****(见 markdown-mapping-v0.3.md §7.2)。
  5. 成段注释:空行分段;段内续行不因首字符升级为代码。
  6. 否决:无标记行 = 默认代码。

详见 keywords.md、markdown-mapping.md、code-vs-comment.md。


v0.3 意向(Proposed · 未实现)

产品方重新审视后,拟在 ADR 0005 下对调架构标记,并放宽叙述面:

概念 v0.2 v0.3 草案
代码段 / 语句 *…* **…**
返回值 **…** *…*
空返回 **** / 空粗体;或 --- 推荐 *None*/*无*;整行 **;兼容 ****;--- 仅叙述
输出 仍为 print / 打印 不变
无标记 = 默认代码 否决 仍否决
叙述中 `名` 通常无绑定义 一律变量;未使用 OK;升参需可执行面读取

完整规则与迁移见 markdown-mapping-v0.3.md。v0.3 已为运行时;本文件历史决议中「--- 收束」已废止。