Add module docstrings

transcoder/audio.py

@@ -1,3 +1,5 @@
+"""Encodes input audio stream into sequence of speaker duty cycle counts."""
+
 from typing import Iterator
 
 import audioread

transcoder/edit_distance.py

@@ -1,3 +1,5 @@
+"""Computes visual differences between screen image data."""
+
 import functools
 
 import numpy as np

transcoder/opcodes.py

@@ -1,3 +1,5 @@
+"""Opcodes representing discrete operations of video player."""
+
 import enum
 from typing import Iterator, Tuple
 

transcoder/opcodes_test.py

@@ -1,3 +1,5 @@
+"""Tests for the opcodes module."""
+
 import unittest
 
 import opcodes

transcoder/symbol_table.py

@@ -1,3 +1,5 @@
+"""Parses the cc65 .dbg output to extract symbol addresses."""
+
 from typing import Dict
 
 

transcoder/symbol_table_test.py

@@ -1,3 +1,5 @@
+"""Tests for the symbol_table module."""
+
 import io
 import unittest
 

transcoder/video.py

@@ -1,3 +1,5 @@
+"""Encode a sequence of images as an optimized stream of screen changes."""
+
 import heapq
 import os
 import queue

transcoder/video_test.py

@@ -1,3 +1,5 @@
+"""Tests for the video module."""
+
 import unittest
 
 import video