diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2012-12-07 23:31:17 -0800 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2012-12-07 23:31:17 -0800 |
| commit | aa1b9037bf609d11ed0a2a4d5f2028c66ffc2351 (patch) | |
| tree | 0a8b5851bb05cb9abd479b9bb1f971ebd434a672 /guides/source/api_documentation_guidelines.md | |
| parent | 1ef8138f9edc23e4146d4d78138e700321586e0b (diff) | |
| download | rails-aa1b9037bf609d11ed0a2a4d5f2028c66ffc2351.tar.gz rails-aa1b9037bf609d11ed0a2a4d5f2028c66ffc2351.tar.bz2 rails-aa1b9037bf609d11ed0a2a4d5f2028c66ffc2351.zip | |
Fill out API Documentation Guidelines 'you will learn' list.
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
| -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 |