doc(twspace, twspace_dl): add documentation

HoloArchivists · May 24, 2023 · 2ecc9af · 2ecc9af
1 parent b29e3b5
commit 2ecc9af
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/twspace_dl/twspace.py b/twspace_dl/twspace.py
@@ -36,7 +36,7 @@ def __init__(self, metadata: dict) -> None:
             if creator_info := root["creator_results"]["result"].get("legacy"):  # type: ignore
                 self["creator_name"] = creator_info["name"]  # type: ignore
                 self["creator_screen_name"] = creator_info["screen_name"]  # type: ignore
-                self["creator_profile_image_url"] = creator_info["profile_image_url_https"].replace("_normal", "")
+                self["creator_profile_image_url"] = creator_info["profile_image_url_https"].replace("_normal", "")  # type: ignore
                 self["creator_id"] = twitter.user_id(
                     "https://twitter.com/" + creator_info["screen_name"]
                 )

diff --git a/twspace_dl/twspace_dl.py b/twspace_dl/twspace_dl.py
@@ -187,6 +187,7 @@ def download(self) -> None:
         logging.info("Finished downloading")
 
     def embed_cover(self):
+        """Embed the user profile image as the cover art"""
         cover_url = self.space["creator_profile_image_url"]
         cover_ext = cover_url.split(".")[-1]
         response = self.session.get(cover_url)