deac/couchrest_model
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

documentation fix

Browse source
This commit is contained in:
Chris Anderson 2008-10-02 10:52:33 -07:00
parent 98923843ef
commit f6f66407c7
2 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.rdoc
View file

@ -50,7 +50,8 @@ Creating and Querying Views:
== CouchRest::Model
CouchRest::Model is a module designed along the lines of DataMapper::Resource. By
including it in your class, suddenly you get all sorts of magic sugar, so that
working with CouchDB in your Rails or Merb app is no harder than working with the
standard SQL alternatives. See the CouchRest::Model documentation for an example article class that illustrates usage.
CouchRest::Model is a module designed along the lines of DataMapper::Resource.
By subclassing, suddenly you get all sorts of powerful sugar, so that working
with CouchDB in your Rails or Merb app is no harder than working with the
standard SQL alternatives. See the CouchRest::Model documentation for an
example article class that illustrates usage.

2
lib/couchrest/core/model.rb
View file

@ -2,7 +2,7 @@
module CouchRest
# = CouchRest::Model - ORM, the CouchDB way
#
# CouchRest::Model provides an ORM-like interface for CouchDB documents. It avoids all usage of <tt>method_missing</tt>, and tries to strike a balance between usability and magic. See CouchRest::Model::MagicViews#view_by for documentation about the view-generation system. For the other class methods, inspiried by DataMapper and ActiveRecord, see CouchRest::Model::ClassMethods. The InstanceMethods are pretty basic.
# CouchRest::Model provides an ORM-like interface for CouchDB documents. It avoids all usage of <tt>method_missing</tt>, and tries to strike a balance between usability and magic. See CouchRest::Model#view_by for documentation about the view-generation system.
#
# ==== Example
#