Skip to content

Commit aa1b903

Browse files
committed
Fill out API Documentation Guidelines 'you will learn' list.
1 parent 1ef8138 commit aa1b903

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

guides/source/api_documentation_guidelines.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ This guide documents the Ruby on Rails API documentation guidelines.
55

66
After reading this guide, you will know:
77

8+
* What RDoc is.
9+
* How to write effective prose for documentation purposes.
10+
* Style guidlines for documenting different kinds of Ruby code.
11+
812
--------------------------------------------------------------------------------
913

1014
RDoc

0 commit comments

Comments
 (0)