update doc for Client usage

tevino · Apr 22, 2014 · 2bb09bc · 2bb09bc
1 parent 6f815d8
commit 2bb09bc
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -5,14 +5,16 @@ Basic
 -------
 
 .. automodule:: mongu
-   :members: register_model, enable_counter
+   :members: enable_counter
 
+.. autoclass:: mongu.Client
+   :members:
 
 Extra
 ------
 
 .. autoclass:: mongu.ObjectDict
-   :members: 
+   :members:
 
 
 Base Model

diff --git a/docs/counter_example.rst b/docs/counter_example.rst
@@ -9,7 +9,7 @@ We don't assume you are stupid::
 
 **Define a Model with CounterMixin**::
 
-    >> @register_model
+    >> @c.register_model
     >> class User(CounterMixin, Model):  # order of base classes matters
     >>     _database_   = 'test'
     >>     _collection_ = 'users'

diff --git a/docs/example.rst b/docs/example.rst
@@ -5,9 +5,11 @@ We don't assume you are stupid, here we go
 
 **Model definition**::
 
-    from mongu import register_model, Model
+    from mongu import Client, Model
 
-    @register_model
+    c = Client()                              # connect to MongoDB
+
+    @c.register_model
     class User(Model):
         _database_   = 'test'                 # database name
         _collection_ = 'users'                # collection name