Doc updates.

andialbrecht · andialbrecht · commit d298f83c4f9d · 2013-01-01T14:35:46.000+01:00
diff --git a/CHANGES b/CHANGES
@@ -1,11 +1,15 @@
 Development Version
 -------------------
 
+sqlparse is now compatible with Python 3 without any patches. The
+Python 3 version is generated during install by 2to3. You'll need
+distribute to install sqlparse for Python 3.
+
 Bug Fixes
  * Fix parsing error with dollar-quoted procedure bodies (issue83).
 
 Other
- * sqlparse is now compatible with Python 3 without any patches.
+ * Documentation updates.
  * py3k fixes (by vthriller).
  * py3k fixes in setup.py (by Florian Bauer).
  * setup.py now requires distribute (by Florian Bauer).
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -1,33 +1,25 @@
 Introduction
 ============
 
-:mod:`sqlparse` is a non-validating SQL parser for Python.
-It provides support for parsing, splitting and formatting SQL statements.
-The module is released under the terms of the
-`New BSD license <http://www.opensource.org/licenses/bsd-license.php>`_.
-
-Visit the project page at http://python-sqlparse.googlecode.com for
-further information about this project.
-
 
 Download & Installation
 -----------------------
 
-The latest released version can be obtained from the
-`downloads page <http://code.google.com/p/python-sqlparse/downloads/list>`_
-on the project's website. To extract the source archive and to install
-the module on your system run
+The latest released version can be obtained from the `Python Package
+Index (PyPI) <http://pypi.python.org/pypi/sqlparse/>`_. To extract the
+install the module system-wide run
 
 .. code-block:: bash
 
    $ tar cvfz python-sqlparse-VERSION.tar.gz
    $ cd python-sqlparse/
    $ sudo python setup.py install
 
-Alternatively you can install :mod:`sqlparse` from the
-`Python Packge Index <http://pypi.python.org/pypi/sqlparse>`_ with your
-favorite tool for installing Python modules. For example when using
-`pip <http://pypi.python.org/pypi/pip>`_ run :command:`pip install sqlparse`.
+Alternatively you can install :mod:`sqlparse` using :command:`pip`:
+
+.. code-block:: bas
+
+   $ pip install sqlparse
 
 
 Getting Started
@@ -108,9 +100,9 @@ Each object can be converted back to a string at any time:
 
 .. code-block:: python
 
-   >>> stmt.to_unicode()
+   >>> unicode(stmt)  # str(stmt) for Python 3
    u'select * from "someschema"."mytable" where id = 1'
-   >>> stmt.tokens[-1].to_unicode()  # or just the WHERE part
+   >>> unicode(stmt.tokens[-1])  # or just the WHERE part
    u'where id = 1'
 
 Details of the returned objects are described in :ref:`analyze`.
diff --git a/sqlparse/sql.py b/sqlparse/sql.py
@@ -45,7 +45,8 @@ def __unicode__(self):
     def to_unicode(self):
         """Returns a unicode representation of this object.
 
-        @deprecated: please use __unicode__()
+        .. deprecated:: 0.1.5
+           Use ``unicode(token)`` (for Python 3: ``str(token)``) instead.
         """
         return unicode(self)
 
