diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-04-29 16:26:38 +0000 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-04-29 16:26:38 +0000 |
| commit | a487142f9b6d4b63270a445d5e3d7517865a00eb (patch) | |
| tree | 384c380758272071846bc2a35e43dfc01c3693ac | |
| parent | ec66cd4c44eda62ab72c11d302b12231c60cf41e (diff) | |
| download | sqlalchemy-a487142f9b6d4b63270a445d5e3d7517865a00eb.tar.gz | |
docstring tweaks
| -rw-r--r-- | doc/build/genhtml.py | 5 | ||||
| -rw-r--r-- | lib/sqlalchemy/sql.py | 12 |
2 files changed, 9 insertions, 8 deletions
diff --git a/doc/build/genhtml.py b/doc/build/genhtml.py index 6ebedff1c..9a15eeb64 100644 --- a/doc/build/genhtml.py +++ b/doc/build/genhtml.py @@ -12,7 +12,7 @@ import optparse files = [ 'index', -# 'documentation', + 'documentation', 'tutorial', 'dbengine', 'metadata', @@ -29,13 +29,14 @@ files = [ parser = optparse.OptionParser(usage = "usage: %prog [options] [tests...]") parser.add_option("--file", action="store", dest="file", help="only generate file <file>") parser.add_option("--docstrings", action="store_true", dest="docstrings", help="only generate docstrings") +parser.add_option("--version", action="store", dest="version", default="0.3.6", help="version string") (options, args) = parser.parse_args() if options.file: files = [file] title='SQLAlchemy 0.3 Documentation' -version = '0.3.6' +version = options.version root = toc.TOCElement('', 'root', '', version=version, doctitle=title) diff --git a/lib/sqlalchemy/sql.py b/lib/sqlalchemy/sql.py index 9c327bd53..cfe571a68 100644 --- a/lib/sqlalchemy/sql.py +++ b/lib/sqlalchemy/sql.py @@ -1393,19 +1393,19 @@ class ColumnElement(Selectable, _CompareMixin): primary_key = property(lambda self:getattr(self, '_primary_key', False), doc=\ - """Primary key flag. Indicates if this Column represents part or - whole of a primary key. + """Primary key flag. Indicates if this ``Column`` represents part or + whole of a primary key for its parent table. """) foreign_keys = property(lambda self:getattr(self, '_foreign_keys', []), doc=\ - """Foreign key accessor. Points to a list of ForeignKey objects - which represents a Foreign Key placed on this column's ultimate + """Foreign key accessor. References a list of ``ForeignKey`` objects + which each represent a foreign key placed on this column's ultimate ancestor. """) columns = property(lambda self:[self], doc=\ - """Columns accessor which just returns self, to provide compatibility - with Selectable objects. + """Columns accessor which returns ``self``, to provide compatibility + with ``Selectable`` objects. """) def _one_fkey(self): |