diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-03-17 16:49:45 +0000 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-03-17 16:49:45 +0000 |
commit | 229d2ee4e9e189feb25578c07c850606178d5b76 (patch) | |
tree | 3894a073cbb3fa82bcd549e212b53b250222b93b /lib/sqlalchemy/schema.py | |
parent | 4f63e40616635ba2dae49c3a416d9e288a9a0860 (diff) | |
download | sqlalchemy-229d2ee4e9e189feb25578c07c850606178d5b76.tar.gz |
integrated docutils formatting into generated documentation;
restructuredtext fixes throughout docstrings
Diffstat (limited to 'lib/sqlalchemy/schema.py')
-rw-r--r-- | lib/sqlalchemy/schema.py | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/lib/sqlalchemy/schema.py b/lib/sqlalchemy/schema.py index 443d48ee5..168a0f90f 100644 --- a/lib/sqlalchemy/schema.py +++ b/lib/sqlalchemy/schema.py @@ -217,10 +217,10 @@ class Table(SchemaItem, sql.TableClause): Further tables constructed with the same name/schema combination will return the same Table instance. - *args + \*args Should contain a listing of the Column objects for this table. - **kwargs + \**kwargs options include: schema @@ -413,11 +413,11 @@ class Column(SchemaItem, sql._ColumnClause): ForeignKey, the type can also be None, in which case the type assigned will be that of the referenced column. - *args + \*args Constraint, ForeignKey, ColumnDefault and Sequence objects should be added as list values. - **kwargs + \**kwargs Keyword arguments include: key @@ -844,8 +844,7 @@ class Sequence(DefaultGenerator): return visitor.visit_sequence(self) class Constraint(SchemaItem): - """Represent a table-level ``Constraint`` such as a composite primary - key, foreign key, or unique constraint. + """Represent a table-level ``Constraint`` such as a composite primary key, foreign key, or unique constraint. Implements a hybrid of dict/setlike behavior with regards to the list of underying columns. @@ -991,15 +990,16 @@ class Index(SchemaItem): name The name of the index - *columns + \*columns Columns to include in the index. All columns must belong to the same table, and no column may appear more than once. - **kwargs + \**kwargs Keyword arguments include: unique Defaults to True: create a unique index. + """ self.name = name @@ -1141,7 +1141,7 @@ class MetaData(SchemaItem): class BoundMetaData(MetaData): """Build upon ``MetaData`` to provide the capability to bind to an - ``Engine`` implementation. +``Engine`` implementation. """ def __init__(self, engine_or_url, name=None, **kwargs): @@ -1155,9 +1155,9 @@ class BoundMetaData(MetaData): return True class DynamicMetaData(MetaData): - """Build upon ``MetaData`` to provide the capability to bind to - multiple ``Engine`` implementations on a dynamically alterable, - thread-local basis. + """Build upon ``MetaData`` to provide the capability to bind to +multiple ``Engine`` implementations on a dynamically alterable, +thread-local basis. """ def __init__(self, name=None, threadlocal=True, **kwargs): |