doc_examples 教程
本页面向维护者,介绍如何运行和扩展 src/doc_examples/README.mbt.md 中的可执行示例。
快速入门
just docs
先运行 tools/doc_quality.py(检查链接、快照、版本),再运行 moon test src/doc_examples --target native --deny-warn,后者会把 README 中的每个 moonbit check 代码块作为测试编译并运行。
日常任务
添加示例
在 src/doc_examples/README.mbt.md 末尾追加一个代码块:
```moonbit check
///|
test "a unique, descriptive name" {
let x = @bin_float.BinFloat::from_int(3)
inspect(x.to_string(), content="3p0")
}
```
使用 src/doc_examples/moon.pkg 中列出的包(如有需要,在那里添加导入),为测试取一个唯一的名字,并用 inspect 展示结果。
只运行这个包
在能解析 Luna-Flow 依赖的工作区中:
moon test -p Luna-Flow/floating/doc_examples
深入了解
手册各页面自带详细示例;doc_examples 只保留一小组跨包工作流,它们必须在该模块的每次测试运行中都能编译。
常见陷阱
--deny-warn会把警告(例如调用已弃用的函数)变为失败。- 未带
check标记的代码块不会被编译。