kotovalexarian-likes-github
/
rails--rails
mirror of https://github.com/rails/rails.git
1
0
Fork 0
Code Releases Activity

Update guides/source/api_documentation_guidelines.md 

Co-authored-by: Eileen M. Uchitelle <eileencodes@users.noreply.github.com>
This commit is contained in:
Xavier Noria 2021-05-13 16:31:27 +02:00 committed by GitHub
parent 164545de36
commit 782bcc4a34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
guides/source/api_documentation_guidelines.md
View File

@ -33,7 +33,7 @@ directives](https://ruby.github.io/rdoc/RDoc/Parser/Ruby.html).
Links
-----
Rails API documentation are not meant to be viewed on GitHub and so links should use the RDoc [`link`](https://ruby.github.io/rdoc/RDoc/Markup.html#class-RDoc::Markup-label-Links) markup relative to the current API.
Rails API documentation are not meant to be viewed on GitHub and therefore links should use the RDoc [`link`](https://ruby.github.io/rdoc/RDoc/Markup.html#class-RDoc::Markup-label-Links) markup relative to the current API.
This is due to differences between GitHub Markdown and the generated RDoc that is published at [api.rubyonrails.org](https://api.rubyonrails.org) and [edgeapi.rubyonrails.org](https://edgeapi.rubyonrails.org).