]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
- fix docstrings
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 8 Jan 2016 21:27:37 +0000 (16:27 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 8 Jan 2016 21:27:37 +0000 (16:27 -0500)
lib/sqlalchemy/sql/compiler.py

index 2fe6ea02c3f3c5a62b3baf248a707679878dbf06..98ab60aaa671ecebce58b210a1c8f122f870f1af 100644 (file)
@@ -168,11 +168,11 @@ class Compiled(object):
 
     def __init__(self, dialect, statement, bind=None,
                  compile_kwargs=util.immutabledict()):
-        """Construct a new ``Compiled`` object.
+        """Construct a new :class:`.Compiled` object.
 
-        :param dialect: ``Dialect`` to compile against.
+        :param dialect: :class:`.Dialect` to compile against.
 
-        :param statement: ``ClauseElement`` to be compiled.
+        :param statement: :class:`.ClauseElement` to be compiled.
 
         :param bind: Optional Engine or Connection to compile this
           statement against.
@@ -288,11 +288,9 @@ class _CompileLabel(visitors.Visitable):
 
 
 class SQLCompiler(Compiled):
+    """Default implementation of :class:`.Compiled`.
 
-    """Default implementation of Compiled.
-
-    Compiles ClauseElements into SQL strings.   Uses a similar visit
-    paradigm as visitors.ClauseVisitor but implements its own traversal.
+    Compiles :class:`.ClauseElement` objects into SQL strings.
 
     """
 
@@ -335,17 +333,20 @@ class SQLCompiler(Compiled):
 
     def __init__(self, dialect, statement, column_keys=None,
                  inline=False, **kwargs):
-        """Construct a new ``DefaultCompiler`` object.
+        """Construct a new :class:`.SQLCompiler` object.
+
+        :param dialect: :class:`.Dialect` to be used
+
+        :param statement: :class:`.ClauseElement` to be compiled
 
-        dialect
-          Dialect to be used
+        :param column_keys:  a list of column names to be compiled into an
+         INSERT or UPDATE statement.
 
-        statement
-          ClauseElement to be compiled
+        :param inline: whether to generate INSERT statements as "inline", e.g.
+         not formatted to return any generated defaults
 
-        column_keys
-          a list of column names to be compiled into an INSERT or UPDATE
-          statement.
+        :param kwargs: additional keyword arguments to be consumed by the
+         superclass.
 
         """
         self.column_keys = column_keys