在 1.9.0-alpha10 版本中,{{explain-data}} 的文档字符串没有提及或描述其返回值中的某些标准键/值的含义,文档字符串中使用 "路径" 的地方可能需要澄清以避免与文件路径或命名空间路径混淆。以下是当前文档字符串:
{quote}
给定一个规范和应遵守的值 x,如果 x 符合,则返回 nil,否则返回一个包含至少 ::problems 键的映射,其中其值为一个问题映射集合,其中问题映射至少包含 :path、:pred 和 :val 键来描述在路径上失败的计算器及其值。
{quote}
以下是可能的替代方案:
{quote}
给定一个规范和应遵守的值 x,如果 x 符合,则返回 nil,否则返回一个至少包含 ::problems 键的映射,其中其值为一个问题映射集合,其中问题映射至少包含 :path、:pred 和 :val 键来描述在路径上失败的计算器及其值(通过可能嵌入的规范)。该映射还可以包含失败的规范中的 :via 键,失败的值的数据键中的 :in 键,以及描述失败原因的 :reason 键。
{quote}
这不同于现有的文档字符串的两种方式:
它将 "(通过可能嵌入的规范)" 插入到现有的文档字符串的最后,以澄清并消除歧义。
它增加了一句话来描述 :via、:in 和 :reason 键。