Updated documentation

mitsuhiko · mitsuhiko · commit fea753b49a6f · 2010-08-03T14:24:13.000+02:00
diff --git a/CHANGES b/CHANGES
@@ -0,0 +1,29 @@
+Changelog
+---------
+
+Here you can see the full list of changes between each Flask-SQLAlchemy
+release.
+
+Version 0.10
+````````````
+
+- Added support for signals.
+- Table names are now automatically set from the class name unless
+  overriden.
+
+Version 0.9
+```````````
+
+- applied changes to pass the Flask extension approval process.
+
+Version 0.8
+```````````
+
+- added a few configuration keys for creating connections.
+- automatically activate connection recycling for MySQL connections.
+- added support for the Flask testing mode.
+
+Version 0.7
+```````````
+
+- Initial public release
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
-include LICENSE *.py
+include LICENSE CHANGES *.py
 recursive-include docs *
 recursive-exclude docs *.pyc
 recursive-exclude docs *.pyo
diff --git a/docs/index.rst b/docs/index.rst
@@ -87,6 +87,11 @@ And how do you get the data back?  Easy as pie:
 >>> admin = User.query.filter_by(username='admin').first()
 <User u'admin'>
 
+.. versionchanged:: 0.10
+   The `__tablename__` attribute is now optional.  If not defined, the
+   class name (converted to lowercases and camel cased words separated
+   by underscores) is used.
+
 Road to Enlightenment
 ---------------------
 
@@ -157,6 +162,34 @@ The following configuration values exist for Flask-SQLAlchemy:
    ``SQLALCHEMY_POOL_TIMEOUT`` and ``SQLALCHEMY_POOL_RECYCLE``
    configuration keys were added.
 
+Signalling Support
+------------------
+
+.. versionadded:: 0.10
+
+Starting with Flask-SQLAlchemy 0.10 you can now connect to signals to be
+notified when certain things happen.
+
+The following two signals exist:
+
+.. data:: models_committed
+
+   This signal is sent when changed models where committed to the
+   database.  The sender is the application that emitted the changes
+   and the models and an operation identifier are passed as list of tuples
+   in the form ``(model, operation)`` to the receiver in the `changes`
+   parameter.
+
+   The model is the instance of the model that was sent to the database
+   and the operation is ``'insert'`` when a model was inserted,
+   ``'delete'`` when the model was deleted and ``'update'`` if any
+   of the columns where updated.
+
+.. data:: before_models_committed
+
+   Works exactly the same as :data:`models_committed` but is emitted
+   right before the comitting takes place.
+
 API
 ---
 
@@ -211,19 +244,4 @@ Utilities
 
 .. autofunction:: get_debug_queries
 
-Changelog
----------
-
-0.8
-```
-
--   added a few configuration keys for creating connections.
-
--   automatically activate connection recycling for MySQL connections.
-
--   added support for the Flask testing mode.
-
-0.7
-```
-
--   Initial public release
+.. include:: ../CHANGES

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-include LICENSE *.py`
	`1`	`+include LICENSE CHANGES *.py`
`2`	`2`	`recursive-include docs *`
`3`	`3`	`recursive-exclude docs *.pyc`
`4`	`4`	`recursive-exclude docs *.pyo`