Changeset 24 for elixir/trunk/elixir/fields.py

Timestamp:

02/03/07 15:35:39 (6 years ago)

Author:

joshua

Message:

* created and added a pudge template (including css and two images)
* added a couple of (mostly empty) rst-files under /doc
* updated some docstrings, so that the generated html-files look prettier
* added setup.cfg and updated setup.py for pudge-integration
* copied docstring from init.py as long_description to setup.py

Files:

• elixir/trunk/elixir/fields.py (modified) (3 diffs)

elixir/trunk/elixir/fields.py

@@ -11 +11 @@
 class Field(object):
     '''
-    Represents the definition of a 'field' on an entity.  In other words, this
-    class represents a column on the table where the entity is stored.  This 
-    object is only used with the 'with_fields' syntax for defining all fields
-    for an entity at the same time.  The 'has_field' syntax does not require 
-    the manual creation of this object.
+    Represents the definition of a 'field' on an entity.
+    
+    This class represents a column on the table where the entity is stored.
+    This object is only used with the ``with_fields`` syntax for defining all
+    fields for an entity at the same time. The ``has_field`` syntax does not
+    require the manual creation of this object.
     '''
     
@@ -42 +43 @@
 class HasField(object):
     '''
-    Statement object for specifying a single field on an entity.  The first
-    argument is the name of the field, the second is its type, and following
-    this any number of keyword arguments can be specified for additional 
-    behavior.  The keyword arguments are passed on to the SQLAlchemy 'Column'
-    object.  Please refer to the SQLAlchemy 'Column' object's documentation for
-    further detail about which keyword arguments are supported.
+    Statement object for specifying a single field on an entity.
     
-    Here is a quick example of how to use 'has_field'.
+    The first argument is the name of the field, the second is its type, and
+    following this any number of keyword arguments can be specified for
+    additional behavior. The keyword arguments are passed on to the SQLAlchemy
+    ``Column`` object. Please refer to the SQLAlchemy ``Column`` object's
+    documentation for further detail about which keyword arguments are
+    supported.
+    
+    Here is a quick example of how to use ``has_field``.
+    
+    ::
     
         class Person(Entity):
@@ -64 +69 @@
 class WithFields(object):
     '''
-    Statement object for specifying all fields on an entity at once.  Each 
-    keyword argument to this statement represents one field, which should be
-    a Field object.  The first argument to a Field object is its type, and 
-    following this any number of keyword arguments can be specified for 
-    additional behavior.  The keyword arguments are passed on to the SQLAlchemy
-    'Column' object.  Please refer to the SQLAlchemy 'Column' object's 
-    documentation for further detail about which keyword arguments are 
+    Statement object for specifying all fields on an entity at once.
+    
+    Each keyword argument to this statement represents one field, which should
+    be a Field object. The first argument to a Field object is its type, and
+    following this any number of keyword arguments can be specified for
+    additional behavior. The keyword arguments are passed on to the SQLAlchemy
+    ``Column`` object. Please refer to the SQLAlchemy ``Column`` object's
+    documentation for further detail about which keyword arguments are
     supported.
     
-    Here is a quick example of how to use 'with_fields'.
+    Here is a quick example of how to use ``with_fields``.
+    
+    ::
     
         class Person(Entity):