Что именно означает метод: method: notation для ruby ​​docs?

Question

Minitest имеет несколько методов, определенных следующим образом:

  ##
  # :method: must_equal
  # See MiniTest::Assertions#assert_equal

  ##
  # :method: must_include
  # See MiniTest::Assertions#assert_includes

  ##
  # :method: must_match
  # See MiniTest::Assertions#assert_match

  ##
  # :method: must_output
  # See MiniTest::Assertions#assert_output

Они определены в модуле Object, поэтому они доступны для всех объектов. Но почему они не появляются в каких-либо документах? Я проверил документы, сгенерированные Yard для rdoc.info, и документы, сгенерированные rdoc, когда я наберу gem rdoc minitest. Они тоже не появляются. Как я могу ссылаться на них, если они нигде не появляются? Что :method: должен делать?

Answer 1

Это похоже на способ документирования метода, который не определен явно. В некоторых случаях вам может понадобиться добавить примечание о методе, который генерируется, например, динамически или загружается из другого модуля, как здесь.