[Sqlalchemy-commits] [2573] sqlalchemy/trunk: docstring tweaks
Brought to you by:
zzzeek
Menu
▾
▴
[Sqlalchemy-commits] [2573] sqlalchemy/trunk: docstring tweaks
|
From: <co...@sq...> - 2007-04-29 16:26:16
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!-- #msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; } #msg dt { float: left; width: 6em; font-weight: bold; } #msg dt:after { content:':';} #msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; } #msg dl a { font-weight: bold} #msg dl a:link { color:#fc3; } #msg dl a:active { color:#ff0; } #msg dl a:visited { color:#cc6; } h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; } #msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; } #msg ul, pre { overflow: auto; } #header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; } #patch { width: 100%; } #patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;} #patch .propset h4, #patch .binary h4 {margin:0;} #patch pre {padding:0;line-height:1.2em;margin:0;} #patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;} #patch .propset .diff, #patch .binary .diff {padding:10px 0;} #patch span {display:block;padding:0 10px;} #patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;} #patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;} #patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;} #patch .lines, .info {color:#888;background:#fff;} --></style> <title>[2573] sqlalchemy/trunk: docstring tweaks</title> </head> <body> <div id="msg"> <dl> <dt>Revision</dt> <dd>2573</dd> <dt>Author</dt> <dd>zzzeek</dd> <dt>Date</dt> <dd>2007-04-29 12:26:38 -0400 (Sun, 29 Apr 2007)</dd> </dl> <h3>Log Message</h3> <pre>docstring tweaks</pre> <h3>Modified Paths</h3> <ul> <li><a href="#sqlalchemytrunkdocbuildgenhtmlpy">sqlalchemy/trunk/doc/build/genhtml.py</a></li> <li><a href="#sqlalchemytrunklibsqlalchemysqlpy">sqlalchemy/trunk/lib/sqlalchemy/sql.py</a></li> </ul> </div> <div id="patch"> <h3>Diff</h3> <a id="sqlalchemytrunkdocbuildgenhtmlpy"></a> <div class="modfile"><h4>Modified: sqlalchemy/trunk/doc/build/genhtml.py (2572 => 2573)</h4> <pre class="diff"><span> <span class="info">--- sqlalchemy/trunk/doc/build/genhtml.py 2007-04-29 16:21:43 UTC (rev 2572) +++ sqlalchemy/trunk/doc/build/genhtml.py 2007-04-29 16:26:38 UTC (rev 2573) </span><span class="lines">@@ -12,7 +12,7 @@ </span><span class="cx"> </span><span class="cx"> files = [ </span><span class="cx"> 'index', </span><del>-# 'documentation', </del><ins>+ 'documentation', </ins><span class="cx"> 'tutorial', </span><span class="cx"> 'dbengine', </span><span class="cx"> 'metadata', </span><span class="lines">@@ -29,13 +29,14 @@ </span><span class="cx"> parser = optparse.OptionParser(usage = "usage: %prog [options] [tests...]") </span><span class="cx"> parser.add_option("--file", action="store", dest="file", help="only generate file <file>") </span><span class="cx"> parser.add_option("--docstrings", action="store_true", dest="docstrings", help="only generate docstrings") </span><ins>+parser.add_option("--version", action="store", dest="version", default="0.3.6", help="version string") </ins><span class="cx"> </span><span class="cx"> (options, args) = parser.parse_args() </span><span class="cx"> if options.file: </span><span class="cx"> files = [file] </span><span class="cx"> </span><span class="cx"> title='SQLAlchemy 0.3 Documentation' </span><del>-version = '0.3.6' </del><ins>+version = options.version </ins><span class="cx"> </span><span class="cx"> root = toc.TOCElement('', 'root', '', version=version, doctitle=title) </span><span class="cx"> </span></span></pre></div> <a id="sqlalchemytrunklibsqlalchemysqlpy"></a> <div class="modfile"><h4>Modified: sqlalchemy/trunk/lib/sqlalchemy/sql.py (2572 => 2573)</h4> <pre class="diff"><span> <span class="info">--- sqlalchemy/trunk/lib/sqlalchemy/sql.py 2007-04-29 16:21:43 UTC (rev 2572) +++ sqlalchemy/trunk/lib/sqlalchemy/sql.py 2007-04-29 16:26:38 UTC (rev 2573) </span><span class="lines">@@ -1393,19 +1393,19 @@ </span><span class="cx"> </span><span class="cx"> primary_key = property(lambda self:getattr(self, '_primary_key', False), </span><span class="cx"> doc=\ </span><del>- """Primary key flag. Indicates if this Column represents part or - whole of a primary key. </del><ins>+ """Primary key flag. Indicates if this ``Column`` represents part or + whole of a primary key for its parent table. </ins><span class="cx"> """) </span><span class="cx"> foreign_keys = property(lambda self:getattr(self, '_foreign_keys', []), </span><span class="cx"> doc=\ </span><del>- """Foreign key accessor. Points to a list of ForeignKey objects - which represents a Foreign Key placed on this column's ultimate </del><ins>+ """Foreign key accessor. References a list of ``ForeignKey`` objects + which each represent a foreign key placed on this column's ultimate </ins><span class="cx"> ancestor. </span><span class="cx"> """) </span><span class="cx"> columns = property(lambda self:[self], </span><span class="cx"> doc=\ </span><del>- """Columns accessor which just returns self, to provide compatibility - with Selectable objects. </del><ins>+ """Columns accessor which returns ``self``, to provide compatibility + with ``Selectable`` objects. </ins><span class="cx"> """) </span><span class="cx"> </span><span class="cx"> def _one_fkey(self): </span></span></pre> </div> </div> </body> </html> |