Skip to content

Commit

Permalink
Improve docstring of BucketStructure
Browse files Browse the repository at this point in the history
  • Loading branch information
agoncharov-reef committed Jun 17, 2022
1 parent 6b55fa9 commit 19490a2
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion b2sdk/bucket.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,17 @@ class ValueNotSet:


class BucketStructure(metaclass=B2TraceMeta):
"""Structure holding all attributes of a bucket."""
"""
Structure holding all attributes of a bucket.
This structure doesn't hold reference to B2Api, so unlike `Bucket` class
it cannot be used to perform any actions. Instead, this class is used
to only hold Bucket's fields for serializing / deserializing.
Also important difference from `Bucket` is that this structure
allows storing subset of fields, setting others to `ValueNotSet`,
which preserves from serializing too much information.
"""

id_: Union[str, ValueNotSet]
account_id: Union[str, ValueNotSet]
Expand Down

0 comments on commit 19490a2

Please sign in to comment.