diff options
| author | Chris McDonough <chrism@agendaless.com> | 2009-01-05 23:36:27 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2009-01-05 23:36:27 +0000 |
| commit | 7ae0c2522bbb2b026bc0370dbb1b1608f146137d (patch) | |
| tree | d46aa3e872eaf70d900af720b7458efd2ed0a189 /docs/api | |
| parent | 96d8a517bf195a1ce0787e6ec16c3db82bef98f5 (diff) | |
| download | pyramid-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')
| -rw-r--r-- | docs/api/traversal.rst | 4 | ||||
| -rw-r--r-- | docs/api/url.rst | 11 |
2 files changed, 13 insertions, 2 deletions
diff --git a/docs/api/traversal.rst b/docs/api/traversal.rst index c9fab7d98..8195ddec4 100644 --- a/docs/api/traversal.rst +++ b/docs/api/traversal.rst @@ -11,8 +11,8 @@ .. autofunction:: find_root - .. autofunction:: model_url - .. autofunction:: model_path +.. note:: A function named ``model_url`` used to be present in this + module. It was moved to :ref:`url_module` in version 0.6.1. 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 + |