From: Vraj Mohan Date: Tue, 12 Nov 2013 23:18:04 +0000 (-0500) Subject: Fix indentation issues in docstrings X-Git-Tag: rel_0_9_0~124^2 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fe1d64473896b1e8abeb8ddb966447632c057321;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Fix indentation issues in docstrings --- diff --git a/lib/sqlalchemy/orm/events.py b/lib/sqlalchemy/orm/events.py index 3b67f767bb..855841408c 100644 --- a/lib/sqlalchemy/orm/events.py +++ b/lib/sqlalchemy/orm/events.py @@ -1295,9 +1295,9 @@ class SessionEvents(event.Events): :param session: The target :class:`.Session`. :param previous_transaction: The :class:`.SessionTransaction` - transactional marker object which was just closed. The current - :class:`.SessionTransaction` for the given :class:`.Session` is - available via the :attr:`.Session.transaction` attribute. + transactional marker object which was just closed. The current + :class:`.SessionTransaction` for the given :class:`.Session` is + available via the :attr:`.Session.transaction` attribute. .. versionadded:: 0.7.3 diff --git a/lib/sqlalchemy/orm/relationships.py b/lib/sqlalchemy/orm/relationships.py index f0b23111c9..8296be60a2 100644 --- a/lib/sqlalchemy/orm/relationships.py +++ b/lib/sqlalchemy/orm/relationships.py @@ -732,7 +732,7 @@ class RelationshipProperty(StrategizedProperty): @util.memoized_property def mapper(self): """The target :class:`.Mapper` referred to by this - :class:`.RelationshipProperty.Comparator. + :class:`.RelationshipProperty.Comparator`. This is the "target" or "remote" side of the :func:`.relationship`. @@ -1372,7 +1372,8 @@ class RelationshipProperty(StrategizedProperty): def table(self): """Return the selectable linked to this :class:`.RelationshipProperty` object's target - :class:`.Mapper`.""" + :class:`.Mapper`. + """ return self.target def do_init(self): diff --git a/lib/sqlalchemy/sql/ddl.py b/lib/sqlalchemy/sql/ddl.py index 72ef077324..f239cdf0f1 100644 --- a/lib/sqlalchemy/sql/ddl.py +++ b/lib/sqlalchemy/sql/ddl.py @@ -195,7 +195,7 @@ class DDLElement(Executable, _DDLCompiles): If the callable returns a true value, the DDL statement will be executed. - :param state: any value which will be passed to the callable_ + :param state: any value which will be passed to the callable\_ as the ``state`` keyword argument. .. seealso:: diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py index b651aef502..7bf543a612 100644 --- a/lib/sqlalchemy/sql/schema.py +++ b/lib/sqlalchemy/sql/schema.py @@ -364,7 +364,8 @@ class Table(SchemaItem, TableClause): @util.deprecated('0.9', 'Use ``table.schema.quote``') def quote_schema(self): """Return the value of the ``quote_schema`` flag passed - to this :class:`.Table`.""" + to this :class:`.Table`. + """ return self.schema.quote diff --git a/lib/sqlalchemy/sql/selectable.py b/lib/sqlalchemy/sql/selectable.py index f83cdf6921..4fcf06290b 100644 --- a/lib/sqlalchemy/sql/selectable.py +++ b/lib/sqlalchemy/sql/selectable.py @@ -246,11 +246,11 @@ class FromClause(Selectable): :param column: the target :class:`.ColumnElement` to be matched :param require_embedded: only return corresponding columns for - the given :class:`.ColumnElement`, if the given :class:`.ColumnElement` - is actually present within a sub-element - of this :class:`.FromClause`. Normally the column will match if - it merely shares a common ancestor with one of the exported - columns of this :class:`.FromClause`. + the given :class:`.ColumnElement`, if the given :class:`.ColumnElement` + is actually present within a sub-element + of this :class:`.FromClause`. Normally the column will match if + it merely shares a common ancestor with one of the exported + columns of this :class:`.FromClause`. """ diff --git a/lib/sqlalchemy/sql/sqltypes.py b/lib/sqlalchemy/sql/sqltypes.py index 01d9181200..82ab3d5560 100644 --- a/lib/sqlalchemy/sql/sqltypes.py +++ b/lib/sqlalchemy/sql/sqltypes.py @@ -645,9 +645,9 @@ class DateTime(_DateAffinity, TypeEngine): """Construct a new :class:`.DateTime`. :param timezone: boolean. If True, and supported by the - backend, will produce 'TIMESTAMP WITH TIMEZONE'. For backends - that don't support timezone aware timestamps, has no - effect. + backend, will produce 'TIMESTAMP WITH TIMEZONE'. For backends + that don't support timezone aware timestamps, has no + effect. """ self.timezone = timezone diff --git a/lib/sqlalchemy/sql/type_api.py b/lib/sqlalchemy/sql/type_api.py index 5d81e4a0cb..12babd2c25 100644 --- a/lib/sqlalchemy/sql/type_api.py +++ b/lib/sqlalchemy/sql/type_api.py @@ -594,7 +594,7 @@ class TypeDecorator(TypeEngine): coerce_to_is_types = (util.NoneType, ) """Specify those Python types which should be coerced at the expression level to "IS " when compared using ``==`` (and same for - ``IS NOT`` in conjunction with ``!=``. + ``IS NOT`` in conjunction with ``!=``. For most SQLAlchemy types, this includes ``NoneType``, as well as ``bool``.