diff options
| author | Prem Sichanugrist <s@sikachu.com> | 2012-09-02 01:08:20 -0400 |
|---|---|---|
| committer | Prem Sichanugrist <s@sikac.hu> | 2012-09-17 15:54:23 -0400 |
| commit | 9873dd800b77105fe17f583f0d036240ef334826 (patch) | |
| tree | f78fc11a0064b1825484744511f399b2b5f5a439 /guides/source/api_documentation_guidelines.md | |
| parent | 31ef4cf656785a190723d2d8fb4c0fd06f4009bc (diff) | |
| download | rails-9873dd800b77105fe17f583f0d036240ef334826.tar.gz rails-9873dd800b77105fe17f583f0d036240ef334826.tar.bz2 rails-9873dd800b77105fe17f583f0d036240ef334826.zip | |
Convert all the links into Markdown format
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 2493829edf..d8839bacf6 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -8,7 +8,7 @@ This guide documents the Ruby on Rails API documentation guidelines. RDoc ---- -The Rails API documentation is generated with RDoc. Please consult the documentation for help with the "markup":http://rdoc.rubyforge.org/RDoc/Markup.html, and also take into account these "additional directives":http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html. +The Rails API documentation is generated with RDoc. Please consult the documentation for help with the [markup](http://rdoc.rubyforge.org/RDoc/Markup.html), and also take into account these [additional directives](http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html). Wording ------- @@ -39,14 +39,14 @@ Use the article "an" for "SQL", as in "an SQL statement". Also "an SQLite databa English ------- -Please use American English (<em>color</em>, <em>center</em>, <em>modularize</em>, etc.). See "a list of American and British English spelling differences here":http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences. +Please use American English (<em>color</em>, <em>center</em>, <em>modularize</em>, etc).. See [a list of American and British English spelling differences here](http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences). Example Code ------------ Choose meaningful examples that depict and cover the basics as well as interesting points or gotchas. -Use two spaces to indent chunks of code--that is, for markup purposes, two spaces with respect to the left margin. The examples themselves should use "Rails coding conventions":contributing_to_ruby_on_rails.html#follow-the-coding-conventions. +Use two spaces to indent chunks of code--that is, for markup purposes, two spaces with respect to the left margin. The examples themselves should use [Rails coding conventions](contributing_to_ruby_on_rails.html#follow-the-coding-conventions). Short docs do not need an explicit "Examples" label to introduce snippets; they just follow paragraphs: |