diff options
| author | Xavier Noria <fxn@hashref.com> | 2010-10-19 22:45:51 +0200 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2010-10-19 22:45:51 +0200 |
| commit | ba1fb51fa5bb843eadd7ff73b492d1ef4a7ec6c1 (patch) | |
| tree | 677726046f517ed6e986f841a4e69d2b55cfa92a /railties/guides/source/api_documentation_guidelines.textile | |
| parent | d7799fadf93647b7c2ae745881882efbc849982b (diff) | |
| download | rails-ba1fb51fa5bb843eadd7ff73b492d1ef4a7ec6c1.tar.gz rails-ba1fb51fa5bb843eadd7ff73b492d1ef4a7ec6c1.tar.bz2 rails-ba1fb51fa5bb843eadd7ff73b492d1ef4a7ec6c1.zip | |
api guidelines: adds a reference to the RDoc documentation where directives like :method: are covered
Diffstat (limited to 'railties/guides/source/api_documentation_guidelines.textile')
| -rw-r--r-- | railties/guides/source/api_documentation_guidelines.textile | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/railties/guides/source/api_documentation_guidelines.textile b/railties/guides/source/api_documentation_guidelines.textile index c2131ff450..900b3fb5d5 100644 --- a/railties/guides/source/api_documentation_guidelines.textile +++ b/railties/guides/source/api_documentation_guidelines.textile @@ -6,7 +6,7 @@ endprologue. h3. RDoc -The Rails API documentation is generated with RDoc 2.5. Please consult the "RDoc documentation":http://rdoc.rubyforge.org/RDoc.htmlFor for help with its markup. +The Rails API documentation is generated with RDoc 2.5. Please consult the documentation for help with the "markup":http://rdoc.rubyforge.org/RDoc.html, and take into account also these "additional directives":http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html. h3. Wording |