From a48ee1b397249302305eb00998e287c62d898c68 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Thu, 9 Sep 2010 09:24:55 -0400 Subject: [PATCH] - add doc pages for exceptions --- doc/build/core/exceptions.rst | 6 ++++++ doc/build/core/index.rst | 1 + doc/build/orm/exceptions.rst | 6 ++++++ doc/build/orm/index.rst | 1 + doc/build/static/docs.css | 3 ++- lib/sqlalchemy/exc.py | 4 ++-- lib/sqlalchemy/orm/exc.py | 2 +- 7 files changed, 19 insertions(+), 4 deletions(-) create mode 100644 doc/build/core/exceptions.rst create mode 100644 doc/build/orm/exceptions.rst diff --git a/doc/build/core/exceptions.rst b/doc/build/core/exceptions.rst new file mode 100644 index 0000000000..f7d384ad96 --- /dev/null +++ b/doc/build/core/exceptions.rst @@ -0,0 +1,6 @@ +Core Exceptions +=============== + +.. automodule:: sqlalchemy.exc + :show-inheritance: + :members: \ No newline at end of file diff --git a/doc/build/core/index.rst b/doc/build/core/index.rst index bd7b565961..377d475e72 100644 --- a/doc/build/core/index.rst +++ b/doc/build/core/index.rst @@ -14,6 +14,7 @@ SQLAlchemy Core schema types interfaces + exceptions compiler serializer diff --git a/doc/build/orm/exceptions.rst b/doc/build/orm/exceptions.rst new file mode 100644 index 0000000000..1dde4248fc --- /dev/null +++ b/doc/build/orm/exceptions.rst @@ -0,0 +1,6 @@ +ORM Exceptions +============== + +.. automodule:: sqlalchemy.orm.exc + :show-inheritance: + :members: \ No newline at end of file diff --git a/doc/build/orm/index.rst b/doc/build/orm/index.rst index a2e6fbf0ab..dafff384d3 100644 --- a/doc/build/orm/index.rst +++ b/doc/build/orm/index.rst @@ -15,6 +15,7 @@ SQLAlchemy ORM query loading interfaces + exceptions extensions/index examples diff --git a/doc/build/static/docs.css b/doc/build/static/docs.css index 145e49b8c0..23513dbbad 100644 --- a/doc/build/static/docs.css +++ b/doc/build/static/docs.css @@ -260,7 +260,8 @@ dl.function > dt, dl.attribute > dt, dl.classmethod > dt, dl.method > dt, -dl.class > dt +dl.class > dt, +dl.exception > dt { background-color:#F0F0F0; margin:0px -10px; diff --git a/lib/sqlalchemy/exc.py b/lib/sqlalchemy/exc.py index 1c412824cc..003969f56c 100644 --- a/lib/sqlalchemy/exc.py +++ b/lib/sqlalchemy/exc.py @@ -5,9 +5,9 @@ """Exceptions used with SQLAlchemy. -The base exception class is SQLAlchemyError. Exceptions which are raised as a +The base exception class is :class:`.SQLAlchemyError`. Exceptions which are raised as a result of DBAPI exceptions are all subclasses of -:class:`~sqlalchemy.exc.DBAPIError`. +:class:`.DBAPIError`. """ diff --git a/lib/sqlalchemy/orm/exc.py b/lib/sqlalchemy/orm/exc.py index 3f28a3dd32..8f257bdd51 100644 --- a/lib/sqlalchemy/orm/exc.py +++ b/lib/sqlalchemy/orm/exc.py @@ -38,7 +38,7 @@ class FlushError(sa.exc.SQLAlchemyError): class UnmappedError(sa.exc.InvalidRequestError): - """TODO""" + """Base for exceptions that involve expected mappings not present.""" class DetachedInstanceError(sa.exc.SQLAlchemyError): """An attempt to access unloaded attributes on a -- 2.47.2