Skip to content
Browse files

Fill out API Documentation Guidelines 'you will learn' list.

  • Loading branch information...
1 parent 1ef8138 commit aa1b9037bf609d11ed0a2a4d5f2028c66ffc2351 @steveklabnik steveklabnik committed
Showing with 4 additions and 0 deletions.
  1. +4 −0 guides/source/api_documentation_guidelines.md
View
4 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

0 comments on commit aa1b903

Please sign in to comment.
Something went wrong with that request. Please try again.