Я пытался задокументировать некоторый код Ruby, используя yard
, и хотя я делаю именно то, что описано здесь или здесь
# @param [Integer] the number of trials (>= 0)
# @param [Float] success probability in each trial
def initialize(n, p)
# initialize...
end
Я все еще получаю эту странную ошибку
@param tag has unknown parameter name: the
@param tag has unknown parameter name: success
и тогда сгенерированный html выглядит странно. Я звоню yard
этому:
$ yard doc -m markdown
Что я могу делать неправильно?