Docstrings.

Author: toddbirchard

asyncio_tutorial/part_II_aiohttp_aiofiles/loops.py

@@ -1,10 +1,11 @@
+"""Interact with a running event loop."""
 import asyncio
 
 from asyncio_tutorial.logger import LOGGER
 
 
 def inspect_event_loop():
-    """Get event loop info."""
+    """Inspect metadata for the current running event loop."""
     loop = asyncio.get_event_loop()
     thread_id = loop.__dict__.get("_thread_id")
     if loop.is_running():

asyncio_tutorial/part_II_aiohttp_aiofiles/tasks.py

@@ -12,7 +12,7 @@ async def create_tasks(
     session: ClientSession, urls: List[str], directory
 ) -> List[Task]:
     """
-    Create asyncio tasks to be executed.
+    Create asyncio tasks to be execute the `fetch_and_save_url` coroutinne.
 
     :param ClientSession session: Async HTTP requests session.
     :param List[str] urls: Resource URLs to fetch.

asyncio_tutorial/part_I_asyncio_intro/__init__.py

@@ -1,4 +1,4 @@
-"""Simple script to create and execute tasks in a loop"""
+"""Create and execute asynchronous tasks in a loop."""
 import asyncio
 
 from asyncio_tutorial.logger import LOGGER
@@ -10,7 +10,7 @@
 
 
 async def asyncio_intro_tutorial():
-    """Simple demonstration of a async script lifecycle"""
+    """Demo of an asynchronous script's lifecycle."""
     LOGGER.info(f"Asyncio tutorial Part I: Intro to Asyncio.")
     tasks = []
     future = register_future()

asyncio_tutorial/part_I_asyncio_intro/coroutines.py

@@ -1,15 +1,15 @@
-"""Create a coroutine containing the business logic of our task."""
+"""Create a coroutine function to be executed as asyncio task."""
 import asyncio
 
 from asyncio_tutorial.logger import LOGGER
 
 
 async def simple_coroutine(number: int, delay=1):
     """
-    Wait for a time delay, log number associated with the coroutine.
+    Wait for a time delay & display number associated with coroutine.
 
     :param int number: Number to identify the current coroutine.
-    :param int delay: Time delay to simulate a function which takes time to complete.
+    :param int delay: Time delay to simulate function delay.
     """
     await asyncio.sleep(delay)
     LOGGER.info(f"This is Coroutine {number} being executed.")

asyncio_tutorial/part_I_asyncio_intro/futures.py

@@ -1,4 +1,4 @@
-"""Create a Future (callback): an action to be taken when loop is completed."""
+"""Future which executes an action when loop is completed."""
 import asyncio
 from asyncio import Future
 
@@ -7,7 +7,7 @@
 
 def register_future() -> Future:
     """
-    Create a Future to log when loop is completed.
+    Create a Future which triggers a callback when loop is completed.
 
     :returns: Future
     """
@@ -19,11 +19,11 @@ def register_future() -> Future:
 
 def loop_completed(result: str):
     """
-    Callback to be called when loop is complete.
+    Callback function fired when loop is complete.
 
-    :param str result: Simple string describing the state of the loop
+    :param str result: String describing the state of the loop
     """
     LOGGER.success(
         f"Loop completed with result: {result} \
-    \n-------------------------------------------------"
+        \n--------------------------------------"
     )

asyncio_tutorial/part_I_asyncio_intro/loops.py

@@ -1,10 +1,11 @@
+"""Interact with a running event loop."""
 import asyncio
 
 from asyncio_tutorial.logger import LOGGER
 
 
 def inspect_event_loop():
-    """Get event loop info."""
+    """Inspect metadata for the current running event loop."""
     loop = asyncio.get_event_loop()
     thread_id = loop.__dict__.get("_thread_id")
     if loop.is_running():

asyncio_tutorial/part_I_asyncio_intro/tasks.py

@@ -1,4 +1,4 @@
-"""Create task from provided coroutine."""
+"""Create task from coroutine which displays a value after a delay."""
 import asyncio
 from asyncio import Task