From 5ffd5fa3f3f52f921bc9fa8b87ca7e900e8b0d9c Mon Sep 17 00:00:00 2001 From: Conrad Beach Date: Tue, 19 Jun 2018 16:16:48 -0600 Subject: [PATCH] [Fix #420] Recommend YARD instead of RDoc for API documentation --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ea5f2c371..41f30ea57 100644 --- a/README.md +++ b/README.md @@ -695,10 +695,10 @@ Translations of the guide are available in the following languages: num = 1234 ``` -* - Use [Rdoc][rdoc] and its conventions for API documentation. Don't put an +* + Use [YARD][yard] and its conventions for API documentation. Don't put an empty line between the comment block and the `def`. -[[link](#rdoc-conventions)] +[[link](#api-documentation)] * Limit lines to 80 characters. @@ -4479,4 +4479,4 @@ Cheers,
[trpl]: http://www.amazon.com/Ruby-Programming-Language-David-Flanagan/dp/0596516177 [Pandoc]: http://pandoc.org/ [RuboCop]: https://github.com/rubocop-hq/rubocop -[rdoc]: http://rdoc.sourceforge.net/doc/ +[yard]: https://yardoc.org/