Improve module docstrings

configzen/__init__.py

@@ -1,10 +1,6 @@
 # SPDX-License-Identifier: GPL-3.0
 # (C) 2024-present Bartosz Sławecki (bswck)
-"""
-`configzen`.
-
-Manage configuration with pydantic.
-"""
+"""Manage configuration with pydantic."""
 
 from __future__ import annotations
 

configzen/config.py

@@ -1,4 +1,4 @@
-"""`configzen.config`: the base configuration model, `BaseConfig`."""
+"""The base configuration model class [`BaseConfig`][configzen.config.BaseConfig]."""
 
 from __future__ import annotations
 

configzen/context.py

@@ -1,4 +1,4 @@
-"""`configzen.context`: Isolate the library context from the user context."""
+"""Facilities for [contextual][contextvars] processing."""
 
 from __future__ import annotations
 

configzen/data.py

@@ -1,4 +1,4 @@
-"""`configzen.data`: Encapsulate configuring and using data formats within configzen."""
+"""Interfaces for encapsulation of configuring and using data formats."""
 
 from __future__ import annotations
 

configzen/errors.py

@@ -1,4 +1,4 @@
-"""`configzen.errors`: Specialized exceptions raised by configzen."""
+"""Specialized exceptions raised by configzen."""
 
 from __future__ import annotations
 

configzen/module_proxy.py

@@ -1,4 +1,4 @@
-"""`configzen.module_proxy`: Runtime modules wrapping with attribute type validation."""
+"""Runtime modules with attribute type validation."""
 
 from __future__ import annotations
 

configzen/processor.py

@@ -1,5 +1,5 @@
 """
-`configzen.replacements`: Replacement API processor for configuration data.
+Replacement API processor for configuration data.
 
 Allows to tweak the configuration data programmatically before it is given
 to the model config and revert the changes back to the original data structure

configzen/routes.py

@@ -1,4 +1,4 @@
-"""`configzen.route`: Routes creation and parsing."""
+"""Routes creation and parsing."""
 
 from __future__ import annotations
 

configzen/sources.py

@@ -1,4 +1,4 @@
-"""`configzen.sources`: Sources and destinations that hold the configuration data."""
+"""Sources and destinations that hold the configuration data."""
 
 from __future__ import annotations
 

configzen/typedefs.py

@@ -1,4 +1,4 @@
-"""`configzen.typedefs`: Miscellaneous type definitions for configzen."""
+"""Miscellaneous type definitions for configzen."""
 
 from __future__ import annotations