仓库约定
以下规则是 mare_mark 在 Luna-Flow 文档标准之外补充的约定。
能力描述
各页面描述当前分支实现的内容。只有当代码和针对性测试都覆盖某项能力时,它才会被记录为可用。被记录但不被执行的字段和枚举分支(例如 ValidationCoverage)也会如实说明,每个设计页面都以该包的边界结尾。
包页面
每个包(包括 cli 可执行程序和小型的 ir_sink 外观)都有一个 API 页面、一个教程和一个设计页面。没有单独的包参考;概览中的包表格链接了每个包的全部三个页面。report、runner 和 stats 还在其源码旁保留一个简短的 README.mbt.md,作为指向本手册的包内指引。
示例
可运行的示例是完整的 test 或 async test 块,它们用 inspect 或 debug_inspect 展示输出,并按 验证 中的描述进行检查。示例从不展示依赖机器的值,例如计时或基于真实测量的决策。
单位与名称
除非页面另有说明,时间均以微秒为单位,写作 µs。相对差值以百分比表示。模式标识符(mmkp_1、mmka_1、mmks_1、mmkts_1)按其在产物中出现的形式原样书写。
翻译
命令、标识符、包路径、模式名称和版本号在所有译文中都保持不变。