docs: Update docstring for lifecycle_rules to match generator behavior (#841)

andrewsg · parthea · web-flow · commit 36fb81b5b0e5 · 2022-08-12T12:19:06.000-04:00
Co-authored-by: Anthonios Partheniou &lt;partheniou@google.com&gt;
diff --git a/google/cloud/storage/bucket.py b/google/cloud/storage/bucket.py
@@ -2273,12 +2273,12 @@ def lifecycle_rules(self):
 
         .. note::
 
-           The getter for this property returns a list which contains
+           The getter for this property returns a generator which yields
            *copies* of the bucket's lifecycle rules mappings.  Mutating the
-           list or one of its dicts has no effect unless you then re-assign
-           the dict via the setter.  E.g.:
+           output dicts has no effect unless you then re-assign the dict via
+           the setter.  E.g.:
 
-           >>> rules = bucket.lifecycle_rules
+           >>> rules = list(bucket.lifecycle_rules)
            >>> rules.append({'origin': '/foo', ...})
            >>> rules[1]['rule']['action']['type'] = 'Delete'
            >>> del rules[0]
