diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-12-18 23:53:40 +0000 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2007-12-18 23:53:40 +0000 |
commit | ba0267a955d40efb09de06ce226fbab63994aa78 (patch) | |
tree | b2a24709e6b3c474949e0ee50b2755c24cc49e56 /lib/sqlalchemy/engine/url.py | |
parent | 1dc4546aa95d3adfff910430afe922bf137bf595 (diff) | |
download | sqlalchemy-ba0267a955d40efb09de06ce226fbab63994aa78.tar.gz |
introductory docstring bonanza
Diffstat (limited to 'lib/sqlalchemy/engine/url.py')
-rw-r--r-- | lib/sqlalchemy/engine/url.py | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/sqlalchemy/engine/url.py b/lib/sqlalchemy/engine/url.py index a3487638c..663819f05 100644 --- a/lib/sqlalchemy/engine/url.py +++ b/lib/sqlalchemy/engine/url.py @@ -1,4 +1,10 @@ -"""Provides URL facilities for specifying database connections.""" +"""Provides the [sqlalchemy.engine.url#URL] class which encapsulates +information about a database connection specification. + +The URL object is created automatically when [sqlalchemy.engine#create_engine()] is called +with a string argument; alternatively, the URL is a public-facing construct which can +be used directly and is also accepted directly by ``create_engine()``. +""" import re, cgi, sys, urllib from sqlalchemy import exceptions |