rspec-api-documentation - rspec_api_documentation 资源可以有解释。那么为什么它们不在 raddocs html 中显示呢？

Question

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

例子：

user_spec.rb：

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

索引.json：

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

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

Answer 1

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

Answer 2

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