diff options
| author | Tim Graham <timograham@gmail.com> | 2018-08-16 04:37:33 -0400 |
|---|---|---|
| committer | Carlton Gibson <carlton.gibson@noumenal.es> | 2018-08-16 10:39:53 +0200 |
| commit | 5628a8a23f462229a6511aa9d7875efae8ae54d5 (patch) | |
| tree | 22a656d50df288d729bc6f3c73b50493161b4703 | |
| parent | ef306338eb1a8572c1f3203b29dff933bd2c5330 (diff) | |
[2.1.x] Fixed #29677 -- Doc'd return value of StaticFilesStorage.post_process().
Backport of 7f6b013bf60e6168a7e0a8f2b97954c3a45725e0 from master
| -rw-r--r-- | docs/ref/contrib/staticfiles.txt | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/ref/contrib/staticfiles.txt b/docs/ref/contrib/staticfiles.txt index 2c300a1d03..d40327b78e 100644 --- a/docs/ref/contrib/staticfiles.txt +++ b/docs/ref/contrib/staticfiles.txt @@ -249,9 +249,13 @@ as the base URL. .. method:: storage.StaticFilesStorage.post_process(paths, **options) -This method is called by the :djadmin:`collectstatic` management command -after each run and gets passed the local storages and paths of found -files as a dictionary, as well as the command line options. +If this method is defined on a storage, it's called by the +:djadmin:`collectstatic` management command after each run and gets passed the +local storages and paths of found files as a dictionary, as well as the command +line options. It yields tuples of three values: +``original_path, processed_path, processed``. The path values are strings and +``processed`` is a boolean indicating whether or not the value was +post-processed, or an exception if post-processing failed. The :class:`~django.contrib.staticfiles.storage.CachedStaticFilesStorage` uses this behind the scenes to replace the paths with their hashed |