summaryrefslogtreecommitdiff
path: root/docs/api/url.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-01-05 23:36:27 +0000
committerChris McDonough <chrism@agendaless.com>2009-01-05 23:36:27 +0000
commit7ae0c2522bbb2b026bc0370dbb1b1608f146137d (patch)
treed46aa3e872eaf70d900af720b7458efd2ed0a189 /docs/api/url.rst
parent96d8a517bf195a1ce0787e6ec16c3db82bef98f5 (diff)
downloadpyramid-7ae0c2522bbb2b026bc0370dbb1b1608f146137d.tar.gz
pyramid-7ae0c2522bbb2b026bc0370dbb1b1608f146137d.tar.bz2
pyramid-7ae0c2522bbb2b026bc0370dbb1b1608f146137d.zip
New Modules
- A new module ``repoze.bfg.url`` has been added. It contains the ``model_url`` API (moved from ``repoze.bfg.traversal``) and an implementation of ``urlencode`` (like Python's ``urllib.urlencode``) which can handle Unicode keys and values in parameters to the ``query`` argument. Deprecations - The ``model_url`` function has been moved from ``repoze.bfg.traversal`` into ``repoze.bfg.url``. It can still be imported from ``repoze.bfg.traversal`` but an import from ``repoze.bfg.traversal`` will emit a DeprecationWarning. Features - The ``repoze.bfg.url.model_url`` API (nee' ``repoze.bfg.traversal.model_url``) now accepts and honors a keyword argument named ``query``. The value of this argument will be used to compose a query string, which will be attached to the generated URL before it is returned. See the API docs (in the docs directory or `on the web <http://static.repoze.org/bfgdocs>`_) for more information.
Diffstat (limited to 'docs/api/url.rst')
-rw-r--r--docs/api/url.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/api/url.rst b/docs/api/url.rst
new file mode 100644
index 000000000..d984dcc07
--- /dev/null
+++ b/docs/api/url.rst
@@ -0,0 +1,11 @@
+.. _url_module:
+
+:mod:`repoze.bfg.url`
+---------------------
+
+.. automodule:: repoze.bfg.url
+
+ .. autofunction:: model_url
+
+ .. autofunction:: urlencode
+