From b2fc4ace7fdb1dd2e90d6d3cc82f7b7b923ffa68 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Tue, 8 Dec 2015 13:19:56 -0600 Subject: update docs on pathspec arg to ICacheBuster --- pyramid/interfaces.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/pyramid/interfaces.py b/pyramid/interfaces.py index bdf5bdfbe..153fdad03 100644 --- a/pyramid/interfaces.py +++ b/pyramid/interfaces.py @@ -1204,8 +1204,16 @@ class ICacheBuster(Interface): The ``kw`` argument is a dict of keywords that are to be passed eventually to :meth:`~pyramid.request.Request.static_url` for URL generation. The return value should be a two-tuple of - ``(subpath, kw)`` which are versions of the same arguments modified - to include the cache bust token in the generated URL. + ``(subpath, kw)`` where ``subpath`` is the relative URL from where the + file is served and ``kw`` is the same input argument. The return value + should be modified to include the cache bust token in the generated + URL. + + The ``pathspec`` refers to original location of the file, ignoring any + calls to :meth:`pyramid.config.Configurator.override_asset`. For + example, with a call ``request.static_url('myapp:static/foo.png'), the + ``pathspec`` may be ``themepkg:bar.png``, assuming a call to + ``config.override_asset('myapp:static/foo.png', 'themepkg:bar.png')``. """ # configuration phases: a lower phase number means the actions associated -- cgit v1.2.3