]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
whack more long lines in very old docstrings
authorMike Bayer <mike_mp@zzzcomputing.com>
Sat, 2 Feb 2013 23:54:54 +0000 (18:54 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sat, 2 Feb 2013 23:54:54 +0000 (18:54 -0500)
examples/dynamic_dict/__init__.py
examples/elementtree/__init__.py
examples/generic_associations/__init__.py
examples/graphs/__init__.py
examples/inheritance/__init__.py
examples/large_collection/__init__.py
examples/nested_sets/__init__.py
examples/postgis/__init__.py
examples/versioning/__init__.py
examples/vertical/__init__.py

index 3df907cc540663d857d0f932d63cfb811405eb05..7f7b0691d30017850aadca0a8bb11dbb6c71b568 100644 (file)
@@ -1,5 +1,6 @@
-"""Illustrates how to place a dictionary-like facade on top of a "dynamic" relation, so
-that dictionary operations (assuming simple string keys) can operate upon a large
-collection without loading the full collection at once.
+""" Illustrates how to place a dictionary-like facade on top of a
+"dynamic" relation, so that dictionary operations (assuming simple
+string keys) can operate upon a large collection without loading the
+full collection at once.
 
 """
\ No newline at end of file
index ee1e9e193a3204ab85217b53a66ca42d81b50b0c..6462dd56297c19deb8d154d63b25698199ba1bb3 100644 (file)
@@ -9,16 +9,23 @@ xpath-like strings is illustrated as well.
 
 In order of complexity:
 
-* ``pickle.py`` - Quick and dirty, serialize the whole DOM into a BLOB column.  While the example
-  is very brief, it has very limited functionality.
-* ``adjacency_list.py`` - Each DOM node is stored in an individual table row, with attributes
-  represented in a separate table.  The nodes are associated in a hierarchy using an adjacency list
-  structure.  A query function is introduced which can search for nodes along any path with a given
-  structure of attributes, basically a (very narrow) subset of xpath.
-* ``optimized_al.py`` - Uses the same strategy as ``adjacency_list.py``, but associates each
-  DOM row with its owning document row, so that a full document of DOM nodes can be
-  loaded using O(1) queries - the construction of the "hierarchy" is performed after
-  the load in a non-recursive fashion and is much more efficient.
+* ``pickle.py`` - Quick and dirty, serialize the whole DOM into a BLOB
+  column.  While the example   is very brief, it has very limited
+  functionality.
+
+* ``adjacency_list.py`` - Each DOM node is stored in an individual
+  table row, with attributes   represented in a separate table.  The
+  nodes are associated in a hierarchy using an adjacency list
+  structure.  A query function is introduced which can search for nodes
+  along any path with a given   structure of attributes, basically a
+  (very narrow) subset of xpath.
+
+* ``optimized_al.py`` - Uses the same strategy as
+  ``adjacency_list.py``, but associates each   DOM row with its owning
+  document row, so that a full document of DOM nodes can be   loaded
+  using O(1) queries - the construction of the "hierarchy" is performed
+  after the load in a non-recursive fashion and is much more
+  efficient.
 
 E.g.::
 
index 36d50266e2431ef532e6b585d17cfcc0f4d0b1d4..b6cb2408875ab4473808e8a0beb273c79ec77074 100644 (file)
@@ -19,6 +19,7 @@ The configurations include:
 
 The ``discriminator_on_association.py`` script in particular is a modernized
 version of the "polymorphic associations" example present in older versions of
-SQLAlchemy, originally from the blog post at http://techspot.zzzeek.org/2007/05/29/polymorphic-associations-with-sqlalchemy/.
+SQLAlchemy, originally from the blog post at
+http://techspot.zzzeek.org/2007/05/29/polymorphic-associations-with-sqlalchemy/.
 
 """
\ No newline at end of file
index 28a064baddac56dcaf4ebcd6994bdf9017ca9246..629808abe91ffede9e5354bc74da686701357f99 100644 (file)
@@ -1,5 +1,7 @@
-"""
-An example of persistence for a directed graph structure.   The graph is stored as a collection of edges, each referencing both a "lower" and an "upper" node in a table of nodes.  Basic persistence and querying for lower- and upper- neighbors are illustrated::
+"""An example of persistence for a directed graph structure.   The
+graph is stored as a collection of edges, each referencing both a
+"lower" and an "upper" node in a table of nodes.  Basic persistence
+and querying for lower- and upper- neighbors are illustrated::
 
     n2 = Node(2)
     n5 = Node(5)
index a3b85460cdd712c0881ed825e242c3da7a517fd6..09519a679b3c811874c41e9befb37592ce19339d 100644 (file)
@@ -1,4 +1,4 @@
-"""
-Working examples of single-table, joined-table, and concrete-table inheritance as described in :ref:`datamapping_inheritance`.
+"""Working examples of single-table, joined-table, and concrete-table
+inheritance as described in :ref:`datamapping_inheritance`.
 
 """
\ No newline at end of file
index 3982f6799345ddd5c9d9dfffb084fd1db1ad9992..4098cd53a4d9bcb2254c9ba674e362a4fbfb3d90 100644 (file)
@@ -1,8 +1,12 @@
 """Large collection example.
 
-Illustrates the options to use with :func:`~sqlalchemy.orm.relationship()` when the list of related objects is very large, including:
+Illustrates the options to use with
+:func:`~sqlalchemy.orm.relationship()` when the list of related
+objects is very large, including:
 
 * "dynamic" relationships which query slices of data as accessed
-* how to use ON DELETE CASCADE in conjunction with ``passive_deletes=True`` to greatly improve the performance of related collection deletion.
+* how to use ON DELETE CASCADE in conjunction with
+  ``passive_deletes=True`` to greatly improve the performance of
+  related collection deletion.
 
 """
index b730f71734c49b7fe2f4b87684a74fca003e2c1c..1a97b9aef34ca77ebbbcca32fa96d40ebe986835 100644 (file)
@@ -1,4 +1,4 @@
-"""
-Illustrates a rudimentary way to implement the "nested sets" pattern for hierarchical data using the SQLAlchemy ORM.
+""" Illustrates a rudimentary way to implement the "nested sets"
+pattern for hierarchical data using the SQLAlchemy ORM.
 
 """
\ No newline at end of file
index e8f10e59d317228250abdf3387eb2ac8dffec9fd..cec5ad48a322962ca4d4e9b8338a19b11b54d65b 100644 (file)
@@ -1,7 +1,10 @@
 """A naive example illustrating techniques to help
 embed PostGIS functionality.
 
-This example was originally developed in the hopes that it would be extrapolated into a comprehensive PostGIS integration layer.  We are pleased to announce that this has come to fruition as `GeoAlchemy <http://www.geoalchemy.org/>`_.
+This example was originally developed in the hopes that it would be
+extrapolated into a comprehensive PostGIS integration layer.  We are
+pleased to announce that this has come to fruition as `GeoAlchemy
+<http://www.geoalchemy.org/>`_.
 
 The example illustrates:
 
index 72b5afe966e6344ebaab1ab4056e50e6cbb03ff8..4621fae3b38544fdc195c6360c5595b470a110a6 100644 (file)
@@ -46,8 +46,9 @@ A fragment of example usage, using declarative::
                 all() \\
                 == [SomeClassHistory(version=1, name='sc1')]
 
-The ``Versioned`` mixin is designed to work with declarative.  To use the extension with
-classical mappers, the ``_history_mapper`` function can be applied::
+The ``Versioned`` mixin is designed to work with declarative.  To use
+the extension with classical mappers, the ``_history_mapper`` function
+can be applied::
 
     from history_meta import _history_mapper
 
index b4ce291f27fbdef7e53eb6ab9a33382733d2f38e..6073da91c99f2d479e8ad1afd7c6b0cdcec12cc2 100644 (file)
@@ -1,10 +1,16 @@
 """
 Illustrates "vertical table" mappings.
 
-A "vertical table" refers to a technique where individual attributes of an object are stored as distinct rows in a table.
-The "vertical table" technique is used to persist objects which can have a varied set of attributes, at the expense of simple query control and brevity.   It is commonly found in content/document management systems in order to represent user-created structures flexibly.
-
-Two variants on the approach are given.  In the second, each row references a "datatype" which contains information about the type of information stored in the attribute, such as integer, string, or date.
+A "vertical table" refers to a technique where individual attributes
+of an object are stored as distinct rows in a table. The "vertical
+table" technique is used to persist objects which can have a varied
+set of attributes, at the expense of simple query control and brevity.
+It is commonly found in content/document management systems in order
+to represent user-created structures flexibly.
+
+Two variants on the approach are given.  In the second, each row
+references a "datatype" which contains information about the type of
+information stored in the attribute, such as integer, string, or date.
 
 
 Example::