[2.1.x] Fixed #29677 -- Doc'd return value of StaticFilesStorage.post_process().

Backport of 7f6b013bf6 from master
This commit is contained in:
Tim Graham 2018-08-16 04:37:33 -04:00 committed by Carlton Gibson
parent ef306338eb
commit 5628a8a23f
1 changed files with 7 additions and 3 deletions

View File

@ -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