rspec_api_documentation资源可以有解释。那么为什么他们不用raddocs html显示呢？

Question

RspecApiDocumentation中的资源可以有解释。但是，在json html浏览器中使用raddocs格式时，它们不会显示。

示例：

user_spec.rb：

resource 'User' do
  explanation "a User resource, duh"
...

index.json：

{
      "name": "User",
      "explanation": "a User resource, duh"
      ...
}

但是解释没有出现在生成的html中：

Answer 1

原来我使用的是raddocs v 1.1。 raddocs v 2.0中引入了对资源解释的支持。

Answer 2

我遇到了同样的问题，但原因不同。 explanation命令仅适用于resource或example。如果您尝试将多个explanation放在其他位置，则不会产生相应的输出。