Changeset 18 for elixir/trunk/elixir/entity.py

Timestamp:

02/01/07 23:30:27 (6 years ago)

Author:

cleverdevil

Message:

A bunch of docstring updates, representing a good chunk of documentation.
The docstring on relationships is only partially done, as I ran out of
gas after describing the 'belongs_to' relationship type.

Files:

• elixir/trunk/elixir/entity.py (modified) (1 diff)

elixir/trunk/elixir/entity.py

@@ -19 +19 @@
 class Entity(object):
     '''
-    The base class for all entities
+    The base class for all entities.  All Elixir model objects should inherit
+    from this class.  Statements can appear within the body of the definition 
+    of an entity to define its fields, relationships, and other options.  Here
+    is an example:
+    
+        class Person(Entity):
+            has_field('name', Unicode(128))
+            has_field('birthdate', DateTime, default=datetime.now)
+    
+    For further information, please refer to the provided examples or tutorial.
     '''