Branding: apply documentation improvements after review

No code changes in this commit.

Co-authored-by: Shivansh-007 <[email protected]>
Co-authored-by: Joe Banks <[email protected]>

Author: 3 people

bot/exts/backend/branding/_cog.py

@@ -144,7 +144,7 @@ async def apply_asset(self, asset_type: AssetType, download_url: str) -> bool:
 
         timeout = 10  # Seconds.
         try:
-            with async_timeout.timeout(timeout):
+            with async_timeout.timeout(timeout):  # Raise after `timeout` seconds.
                 await pydis.edit(**{asset_type.value: file})
         except discord.HTTPException:
             log.exception("Asset upload to Discord failed.")
@@ -160,7 +160,7 @@ async def apply_banner(self, banner: RemoteObject) -> bool:
         """
         Apply `banner` to the guild and cache its hash if successful.
 
-        Banners should always be applied via this method in order to ensure that the last hash is cached.
+        Banners should always be applied via this method to ensure that the last hash is cached.
 
         Return a boolean indicating whether the application was successful.
         """
@@ -217,9 +217,9 @@ async def maybe_rotate_icons(self) -> None:
         """
         Call `rotate_icons` if the configured amount of time has passed since last rotation.
 
-        We offset the calculated time difference into the future in order to avoid off-by-a-little-bit errors.
-        Because there is work to be done before the timestamp is read and written, the next read will likely
-        commence slightly under 24 hours after the last write.
+        We offset the calculated time difference into the future to avoid off-by-a-little-bit errors. Because there
+        is work to be done before the timestamp is read and written, the next read will likely commence slightly
+        under 24 hours after the last write.
         """
         log.debug("Checking whether it's time for icons to rotate.")
 
@@ -298,7 +298,7 @@ async def enter_event(self, event: Event) -> t.Tuple[bool, bool]:
 
         We cache `event` information to ensure that we:
         * Remember which event we're currently in across restarts
-        * Provide an on-demand information embed without re-querying the branding repository
+        * Provide an on-demand informational embed without re-querying the branding repository
 
         An event change should always be handled via this function, as it ensures that the cache is populated.
 
@@ -487,7 +487,7 @@ async def daemon_before(self) -> None:
         log.trace("Daemon before: calculating time to sleep before loop begins.")
         now = datetime.utcnow()
 
-        # The actual midnight moment is offset into the future in order to prevent issues with imprecise sleep.
+        # The actual midnight moment is offset into the future to prevent issues with imprecise sleep.
         tomorrow = now + timedelta(days=1)
         midnight = datetime.combine(tomorrow, time(minute=1))
 

bot/exts/backend/branding/_repository.py

@@ -19,7 +19,7 @@
     HEADERS["Authorization"] = f"token {Keys.github}"
 
 # Since event periods are year-agnostic, we parse them into `datetime` objects with a manually inserted year.
-# Please note that this is intentionally a leap year in order to allow Feb 29 to be valid.
+# Please note that this is intentionally a leap year to allow Feb 29 to be valid.
 ARBITRARY_YEAR = 2020
 
 # Format used to parse date strings after we inject `ARBITRARY_YEAR` at the end.