在 1.9.0-alpha10 中,explain-data 的文档字符串没有提及或描述其返回值中的一些标准键/值的含义,并且文档字符串中“path”的使用应进一步明确,以避免与文件路径或命名空间路径混淆。以下是当前的文档字符串:
{quote}
给定一个 spec 和一个应遵守的值 x,如果 x 符合,则返回 nil,否则返回至少包含键 ::problems 的映射,该映射的值是问题映射集合,其中问题映射至少包含 :path :pred 和 :val 键,用于描述在给定路径上失败的条件和值。
{quote}
以下是可能的替代方案:
{quote}
给定一个 spec 和一个应遵守的值 x,如果 x 符合,则返回 nil,否则返回至少包含键 ::problems 的映射,该映射的值是问题映射集合,其中问题映射至少包含 :path :pred 和 :val 键,用于描述在给定路径上失败的条件和值(通过可能嵌入的 spec)。映射还可能包含失败的 spec 的 :via 键,失败的值的数据键的 :in 键,以及描述失败原因的 :reason 键。
{quote}
此文档字符串与现有文档字符串有两点不同:
在现有文档字符串的末尾插入 "(通过可能嵌入的 spec)",以阐明并消除此处“path”的含义。
添加了一个描述 :via、:in 和 :reason 键的附加句子。