Permalink
Browse files

Some edits to readme

  • Loading branch information...
1 parent ad2cab0 commit 3f5e7963eb0fc3c61e18810fefbbe9ec3f0f88f0 @theodorton committed Sep 28, 2011
Showing with 5 additions and 6 deletions.
  1. +5 −6 README.md
View
11 README.md
@@ -5,12 +5,6 @@ applications with ActiveRecord. The extension handles attributes,
associations, delegates and scopes. A must for any Rails app using YARD as
documentation plugin.
-The plugin handles the following:
-
-* Attributes
-* Associations
-* Scopes
-
## Attributes ##
In order for this plugin to document any database attributes you need to add
@@ -53,6 +47,11 @@ The plugin handles `has_one`, `belongs_to`, `has_many` and
includes a link to the referred model. For associations with a list of objects
the documentation will simply be marked as `Array<ModelName>`.
+## Delegates ##
+
+The plugin handles `delegate`-methods and marks these delegated instance
+methods simply as aliases for the associated object.
+
## Scopes ##
The plugin will add class methods for any scopes you have defined in your

0 comments on commit 3f5e796

Please sign in to comment.