Commit 7033957c authored by Thomas Lotze's avatar Thomas Lotze Committed by Jim Fulton

updated the docstring of the download utility

parent 69097315
...@@ -45,11 +45,14 @@ class Download(object): ...@@ -45,11 +45,14 @@ class Download(object):
Handles the download cache and offline mode. Handles the download cache and offline mode.
Download(options=None, cache=None, namespace=None, hash_name=False) Download(options=None, cache=None, namespace=None,
offline=False, fallback=False, hash_name=False, logger=None)
options: mapping of buildout options (e.g. a ``buildout`` config section) options: mapping of buildout options (e.g. a ``buildout`` config section)
cache: path to the download cache (excluding namespaces) cache: path to the download cache (excluding namespaces)
namespace: namespace directory to use inside the cache namespace: namespace directory to use inside the cache
offline: whether to operate in offline mode
fallback: whether to use the cache as a fallback (try downloading first)
hash_name: whether to use a hash of the URL as cache file name hash_name: whether to use a hash of the URL as cache file name
logger: an optional logger to receive download-related log messages logger: an optional logger to receive download-related log messages
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment