Skip to content

Commit

Permalink
[Fix #420] Recommend YARD instead of RDoc for API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Conrad Beach authored and bbatsov committed Jun 21, 2018
1 parent cd2a208 commit 5ffd5fa
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -695,10 +695,10 @@ Translations of the guide are available in the following languages:
num = 1234
```

* <a name="rdoc-conventions"></a>
Use [Rdoc][rdoc] and its conventions for API documentation. Don't put an
* <a name="api-documentation"></a>
Use [YARD][yard] and its conventions for API documentation. Don't put an
empty line between the comment block and the `def`.
<sup>[[link](#rdoc-conventions)]</sup>
<sup>[[link](#api-documentation)]</sup>

* <a name="80-character-limits"></a>
Limit lines to 80 characters.
Expand Down Expand Up @@ -4479,4 +4479,4 @@ Cheers,<br>
[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/

0 comments on commit 5ffd5fa

Please sign in to comment.