rdoc report ++没有记录方法中的yield

时间:2014-01-05 09:27:03

标签: ruby rdoc

此方法的文档应已包含参数number

# Iterate and do sth with +number+.
def iterate
  yield(number)
end

但是,rdoc -C1仍然报告某些内容没有记录。

  # ++ is not documented
  def iterate(); end

知道++在报告中的含义以及文档中有什么问题吗?

1 个答案:

答案 0 :(得分:1)

这确实是rdoc中的错误。 ++只是空参数名称,由于源代码解析不正确而出现在方法参数列表中。如果你有一些没有任何参数的方法,但会产生一些东西,就会发生这种情况。

我已经制作了pull request,希望完全解决这个问题。一旦它被包含到下一个rdoc版本中,你的问题就会消失。目前没有解决方法,只需忽略此类消息。