Ответ 1
Обновить последнюю ссылку документацию rdoc можно найти здесь https://ruby.github.io/rdoc/ExampleRDoc_rdoc.html
Документация на rdoc.rubyforge.org кажется более полной, чем версия rdoc.sourceforge.net (который, кстати, имеет модифицированную дату 2003 года).
Кроме того, есть большой источник примеров: ядро Ruby и документация stdlib. Например, взгляните на один из методов класса из File class:
File.atime(имя_файла) = > время
Возвращает последнее время доступа для именованный файл как объект Time).
File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003
Вы можете просмотреть исходный код, включая разметку RDoc, щелкнув по первой строке (на реальной странице RDoc, а не в цитате, включенной в этот ответ). В этом случае метод был реализован в C, но форматирование RDoc такое же, как если бы оно было реализовано в Ruby:
/*
* call-seq:
* File.atime(file_name) => time
*
* Returns the last access time for the named file as a Time object).
*
* File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003
*
*/
Из этого вы можете видеть, что call-seq: позволяет заменить имя и параметры метода текстом по вашему выбору, что очень полезно для методов класса. Он также показывает, как вы можете отображать пример кода в моноширинном шрифте, отступывая его, аналогично Markdown.