Skip to content

Commit c071753

Browse files
committed
Align BPO docstrings with discovery document comments.
1 parent dc281af commit c071753

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

storage/google/cloud/storage/bucket.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ def bucket(self):
320320

321321
@property
322322
def bucket_policy_only(self):
323-
"""Is the bucket configured to allow only IAM policy?
323+
"""If set, access checks only use bucket-level IAM policies or above.
324324
325325
:rtype: bool
326326
:returns: whether the bucket is configured to allow only IAM.
@@ -336,10 +336,17 @@ def bucket_policy_only(self, value):
336336

337337
@property
338338
def locked_time(self):
339-
"""When was the bucket configured to allow only IAM policy?
339+
"""Deadline for changing :attr:`bucket_policy_only` from true to false.
340+
341+
If the bucket's :attr:`bucket_policy_only` is true, this property
342+
is time time after which that setting becomes immutable.
343+
344+
If the bucket's :attr:`bucket_policy_only` is false, this property
345+
is ``None``.
340346
341347
:rtype: Union[:class:`datetime.datetime`, None]
342-
:returns: (readonly) the time the bucket's IAM-only policy was set.
348+
:returns: (readonly) Time after which :attr:`bucket_policy_only` will
349+
be frozen as true.
343350
"""
344351
bpo = self.get("bucketPolicyOnly", {})
345352
stamp = bpo.get("lockedTime")

0 commit comments

Comments
 (0)