From 19490a22d63f16c7f9524b227cf20c2f3d989f40 Mon Sep 17 00:00:00 2001 From: Aleksandr Goncharov Date: Fri, 17 Jun 2022 16:33:29 +0300 Subject: [PATCH] Improve docstring of BucketStructure --- b2sdk/bucket.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/b2sdk/bucket.py b/b2sdk/bucket.py index cc1017143..3c8c177c8 100644 --- a/b2sdk/bucket.py +++ b/b2sdk/bucket.py @@ -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]