diff options
Diffstat (limited to 'guides')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 0126fc94d1..5c4aae8900 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -5,6 +5,10 @@ This guide documents the Ruby on Rails API documentation guidelines. After reading this guide, you will know: +* What RDoc is. +* How to write effective prose for documentation purposes. +* Style guidlines for documenting different kinds of Ruby code. + -------------------------------------------------------------------------------- RDoc |