clarify renew_leases docs on allocate_buckets

This commit is contained in:
Jean-Paul Calderone 2021-11-15 08:08:14 -05:00
parent 6c2e85e991
commit ad6017e63d

View File

@ -284,8 +284,10 @@ class StorageServer(service.MultiService, Referenceable):
"""
Generic bucket allocation API.
:param bool renew_leases: If and only if this is ``True`` then
renew leases on existing shares in this bucket.
:param bool renew_leases: If and only if this is ``True`` then renew a
secret-matching lease on (or, if none match, add a new lease to)
existing shares in this bucket. Any *new* shares are given a new
lease regardless.
"""
# owner_num is not for clients to set, but rather it should be
# curried into the PersonalStorageServer instance that is dedicated