Add missing docstrings for modules

setup.py

@@ -15,9 +15,14 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
-# This is a stub file for older versions of pip, setuptools, etc. that aren't fully
-# compatible with the latest Python packaging standards.
-# See <https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html>
+"""Configure the program for packaging.
+
+This is a stub file for older versions of pip, setuptools, etc. that aren't fully
+compatible with the latest Python packaging standards. Project metadata and dependencies
+have been moved to pyproject.toml.
+
+See <https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html> for info.
+"""
 
 from setuptools import setup
 

src/wikiget/client.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Handle API calls (via mwclient) for site and image information."""
+
 import logging
 from argparse import Namespace
 

src/wikiget/dl.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Prepare and process file downloads."""
+
 import logging
 import sys
 from argparse import Namespace

src/wikiget/exceptions.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Define exceptions specific to the program."""
+
 
 class ParseError(Exception):
     """Raised when some input is unable to be parsed as valid."""

src/wikiget/file.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Define a File class for representing individual files to be downloaded."""
+
 from pathlib import Path
 
 from mwclient.image import Image

src/wikiget/logging.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Configure program log configuration and adapters."""
+
 from __future__ import annotations
 
 import logging

src/wikiget/parse.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Parse download targets and batch files."""
+
 from __future__ import annotations
 
 import fileinput

src/wikiget/validations.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Validate file and site input and verify file hashes."""
+
 from __future__ import annotations
 
 import hashlib

src/wikiget/version.py

@@ -15,4 +15,6 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
-__version__ = "0.8.0"
+"""Set the version string of the program."""
+
+__version__ = "0.8.0.dev0"

src/wikiget/wikiget.py

@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Wikiget. If not, see <https://www.gnu.org/licenses/>.
 
+"""Set up the command-line interface and handle program start and exit."""
+
 from __future__ import annotations
 
 import argparse