rdoc report ++ не документирован с выходом внутри метода

Question

Документ для этого метода должен уже включать параметр number.

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

Однако rdoc -C1 еще сообщает что-то без документов.

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

Любая идея, что означает ++ в отчете и что не так в документе?

Answer 1

Это действительно ошибка в rdoc. ++ - это просто пустое имя параметра, которое появляется в списке параметров метода из-за неправильного разбора исходного кода. Это происходит, когда у вас есть какой-либо метод без каких-либо аргументов, но который что-то дает.

Я сделал pull request, который, надеюсь, полностью устранит эту проблему. Как только он попадет в следующую версию rdoc, ваша проблема исчезнет. На данный момент нет обходного пути, просто игнорируйте такие сообщения.