关于IO.inspect文档spec说明是否存在链接问题的技术问询
关于IO.inspect文档参数链接问题的确认
问题背景
在IO.inspect的文档中,函数的参数定义及spec如下:
inspect(item, opts \ [])
@spec inspect( item, keyword() ) :: item when item: var
结论
该情况属实:
- 参数
item未提供跳转至详细说明的链接,因为item被定义为通用变量类型(var),这类通用类型在文档中通常不会单独设置跳转说明; keyword()的链接指向的是Elixir内置的keyword类型文档,而非options参数的专属说明,这是由于spec中标注的是参数类型,文档工具会默认关联到对应类型的定义文档,而非参数本身的描述内容。
内容的提问来源于stack exchange,提问作者Chen Yu
相关产品推荐
相关产品推荐

