[libcloud] 08/09: Add some comments to the code.

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tomaz pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/libcloud.git

commit 237ea79464741350d11b0018e982881a0df24323
Author: Tomaz Muraus <to...@tomaz.me>
AuthorDate: Wed May 18 12:52:23 2022 +0200

    Add some comments to the code.
---
 libcloud/storage/drivers/s3.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libcloud/storage/drivers/s3.py b/libcloud/storage/drivers/s3.py
index 3dc4237e2..edebe5f71 100644
--- a/libcloud/storage/drivers/s3.py
+++ b/libcloud/storage/drivers/s3.py
@@ -1196,9 +1196,13 @@ class BaseS3StorageDriver(StorageDriver):
 
         extra = {}
 
+        # Not all the S3 compatible implementations return this header, see
+        # https://github.com/apache/libcloud/pull/1695 for details
         if "content-type" in headers:
             extra["content_type"] = headers["content-type"]
 
+        # Google Storage S3 compatible API doesn't return this header under
+        # some scenarios https://github.com/apache/libcloud/issues/1682
         if "etag" in headers:
             extra["etag"] = headers["etag"]