summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2019-01-23 09:31:21 -0500
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2019-01-24 13:02:08 -0500
commit9c33107f48948523737ab3419a08d0fbe5b9474e (patch)
treef0f7aee69fccea3c9fef486a35da511283560c2a
parentbcd19266ead5cabd2805054db2c9375e572f25d9 (diff)
downloadbuildstream-9c33107f48948523737ab3419a08d0fbe5b9474e.tar.gz
_artifactcache.py: Correcting API documenting comment for remove()
This seems to have been copy/pasted from cascache, and documents the function to possibly return None if defer_prune was specified, but this function does not expose defer_prune.
-rw-r--r--buildstream/_artifactcache.py3
1 files changed, 1 insertions, 2 deletions
diff --git a/buildstream/_artifactcache.py b/buildstream/_artifactcache.py
index e16e7d7d2..aa40f571a 100644
--- a/buildstream/_artifactcache.py
+++ b/buildstream/_artifactcache.py
@@ -552,8 +552,7 @@ class ArtifactCache():
# `ArtifactCache.get_artifact_fullname`)
#
# Returns:
- # (int|None) The amount of space pruned from the repository in
- # Bytes, or None if defer_prune is True
+ # (int): The amount of space recovered in the cache, in bytes
#
def remove(self, ref):