diff options
| author | Vraj Mohan <r.vrajmohan@gmail.com> | 2013-11-13 09:40:17 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2013-11-14 21:45:03 -0500 |
| commit | 8ddb4e2959f158d96a6690a19d49f2da1ece7539 (patch) | |
| tree | 7c113af76540425f3c4f4564e10b87d4b6e49cc7 | |
| parent | 92490e0c5d14568724da6238fd72cfa4cb0dae86 (diff) | |
| download | sqlalchemy-8ddb4e2959f158d96a6690a19d49f2da1ece7539.tar.gz | |
Ensure API doc for make_url and resolve references
| -rw-r--r-- | doc/build/changelog/changelog_07.rst | 2 | ||||
| -rw-r--r-- | doc/build/core/engines.rst | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/engine/url.py | 4 |
3 files changed, 5 insertions, 3 deletions
diff --git a/doc/build/changelog/changelog_07.rst b/doc/build/changelog/changelog_07.rst index 655c9b288..c619d31df 100644 --- a/doc/build/changelog/changelog_07.rst +++ b/doc/build/changelog/changelog_07.rst @@ -11,7 +11,7 @@ :tickets: 2851 :versions: 0.8.3, 0.9.0 - The regexp used by the :func:`~.sqlalchemy.engine.url.make_url` function now parses + The regexp used by the :func:`~sqlalchemy.engine.url.make_url` function now parses ipv6 addresses, e.g. surrounded by brackets. .. change:: diff --git a/doc/build/core/engines.rst b/doc/build/core/engines.rst index 5b315fc39..8d34ab5c6 100644 --- a/doc/build/core/engines.rst +++ b/doc/build/core/engines.rst @@ -87,6 +87,8 @@ known driver available for that backend (i.e. cx_oracle, pysqlite/sqlite3, psycopg2, mysqldb). For Jython connections, specify the `zxjdbc` driver, which is the JDBC-DBAPI bridge included with Jython. +.. autofunction:: sqlalchemy.engine.url.make_url + Postgresql ---------- diff --git a/lib/sqlalchemy/engine/url.py b/lib/sqlalchemy/engine/url.py index 08b620752..a61f4a85c 100644 --- a/lib/sqlalchemy/engine/url.py +++ b/lib/sqlalchemy/engine/url.py @@ -24,8 +24,8 @@ class URL(object): Represent the components of a URL used to connect to a database. This object is suitable to be passed directly to a - ``create_engine()`` call. The fields of the URL are parsed from a - string by the ``module-level make_url()`` function. the string + :func:`~sqlalchemy.create_engine` call. The fields of the URL are parsed from a + string by the :func:`.make_url` function. the string format of the URL is an RFC-1738-style string. All initialization parameters are available as public attributes. |