Merge branch 'master' of github.com:mitsuhiko/flask-sqlalchemy

mitsuhiko · mitsuhiko · commit fe710b74c44b · 2010-07-25T19:41:06.000+02:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -28,8 +28,8 @@ or alternatively if you have pip installed::
 How to Use
 ----------
 
-Flask-SQLAlchemy is fun to use, and for the basic applications also
-incredible easy.  For the complete guide, checkout out the API
+Flask-SQLAlchemy is fun to use, and incredibly easy for basic applications.
+For the complete guide, checkout out the API
 documentation on the :class:`SQLAlchemy` class.
 
 Basically all you have to do is to create an :class:`SQLAlchemy` object
@@ -61,7 +61,7 @@ and use this to declare models.  Here a complete example::
         def __repr__(self):
             return '<User %r>' % self.username
 
-So how to create that database, just import the `db` object from your
+To create the initial database, just import the `db` object from a
 interactive Python shell and run the :meth:`~SQLAlchemy.create_all` method
 to create the tables and database:
 
@@ -74,7 +74,7 @@ Boom, and there is your database.  Now to create some users:
 >>> admin = User('admin', 'open sesame')
 >>> guest = User('guest', 'i-shall-pass')
 
-But they are still not in the database, so let's make sure they are:
+But they are not yet in the database, so let's make sure they are:
 
 >>> db.session.add(admin)
 >>> db.session.add(guest)
@@ -90,17 +90,16 @@ And how do you get the data back?  Easy as pie:
 Road to Enlightenment
 ---------------------
 
-All you need to know compared to plain SQLAlchemy is this:
+The only things you need to know compared to plain SQLAlchemy are:
 
 1.  :class:`SQLAlchemy` gives you access to the following things:
 
     -   all the functions and classes from :mod:`sqlalchemy` and
         :mod:`sqlalchemy.orm`
     -   a preconfigured scoped session called `session`
     -   the `metadata`
-    -   as well as a :meth:`SQLAlchemy.create_all` and
-        :meth:`SQLAlchemy.drop_all` methods to create and drop
-        tables according to the models.
+    -   a :meth:`SQLAlchemy.create_all` and :meth:`SQLAlchemy.drop_all`
+        methods to create and drop tables according to the models.
     -   a :class:`Model` baseclass that is a configured declarative base.
 
 2.  The :class:`Model` declarative base class behaves like a regular
@@ -121,7 +120,7 @@ The following configuration values exist for Flask-SQLAlchemy:
 .. tabularcolumns:: |p{6.5cm}|p{8.5cm}|
 
 =============================== =========================================
-``SQLALCHEMY_DATABASE_URI``     the database URI that should be used for
+``SQLALCHEMY_DATABASE_URI``     The database URI that should be used for
                                 the connection.  Examples:
 
                                 - ``sqlite:////tmp/test.db``
@@ -139,14 +138,14 @@ The following configuration values exist for Flask-SQLAlchemy:
                                 some database adapters like postgres when
                                 used with inproper database defaults that
                                 specify encoding-less databases (like
-                                postgres on some ubuntu versions)
-``SQLALCHEMY_POOL_SIZE``        the size of the database pool.  Defaults
-                                to engine defaults (usually 5)
-``SQLALCHEMY_POOL_TIMEOUT``     specifies the connection timeout for the
-                                pool.  Defaults to 10
-``SQLALCHEMY_POOL_RECYCLE``     number of sections after which a
+                                postgres on some Ubuntu versions)
+``SQLALCHEMY_POOL_SIZE``        The size of the database pool.  Defaults
+                                to the engine's default (usually 5)
+``SQLALCHEMY_POOL_TIMEOUT``     Specifies the connection timeout for the
+                                pool.  Defaults to 10.
+``SQLALCHEMY_POOL_RECYCLE``     Number of seconds after which a
                                 connection is automatically recycled.
-                                This is required for MySQL that removes
+                                This is required for MySQL, which removes
                                 connections after 8 hours idle by
                                 default.  Note that Flask-SQLAlchemy
                                 automatically sets this to 2 hours if
@@ -161,8 +160,8 @@ The following configuration values exist for Flask-SQLAlchemy:
 API
 ---
 
-This part of the documentation documents each and every public class or
-function from Flask-SQLAlchemy.
+This part of the documentation documents all the public classes and
+functions in Flask-SQLAlchemy.
 
 Configuration
 `````````````
@@ -179,11 +178,6 @@ Models
 .. autoclass:: BaseQuery
    :members: get, get_or_404, paginate, first_or_404
 
-   .. method:: get(ident)
-
-      Return an instance of the object based on the given identifier
-      (primary key), or `None` if not found.
-
    .. method:: all()
 
       Return the results represented by this query as a list.  This
diff --git a/flaskext/sqlalchemy.py b/flaskext/sqlalchemy.py
@@ -120,7 +120,7 @@ def get_debug_queries():
 
     `start_time` / `end_time`
         Time the query started / the results arrived.  Please keep in mind
-        that the timer function used for your platform might different this
+        that the timer function used depends on your platform. These
         values are only useful for sorting or comparing.  They do not
         necessarily represent an absolute timestamp.
 
@@ -206,7 +206,7 @@ def iter_pages(self, left_edge=2, left_current=2,
               <div class=pagination>
               {%- for page in pagination.iter_pages() %}
                 {% if page %}
-                  {% if page != pagination.numbers %}
+                  {% if page != pagination.page %}
                     <a href="{{ url_for(endpoint, page=page) }}">{{ page }}</a>
                   {% else %}
                     <strong>{{ page }}</strong>
@@ -359,7 +359,7 @@ def create_app():
 
     The difference between the two is that in the first case methods like
     :meth:`create_all` and :meth:`drop_all` will work all the time but in
-    the section case a :meth:`flask.Flask.request_context` has to exist.
+    the second case a :meth:`flask.Flask.request_context` has to exist.
 
     By default Flask-SQLAlchemy will apply some backend-specific settings
     to improve your experience with them.  As of SQLAlchemy 0.6 SQLAlchemy
