update: module docstrings

CHANGELOG.md

@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Use git commit for `construct-typing` which has fixed certain bugs.
 - Rename `PlaylistItemBase` to `PLItemBase` and `PatternPlaylistItem` to `PatternPLItem`.
 - Rename `Polyphony` members `is_mono` to `mono` and `is_porta` to `porta`.
+- `NoModelsFound` also bases `LookupError` now.
 
 ### Fixed
 

pyflp/_events.py

@@ -11,7 +11,7 @@
 # GNU General Public License along with this program. If not, see
 # <https://www.gnu.org/licenses/>.
 
-"""Contains implementations for various types of event data representations.
+"""Contains implementations for various types of event data and its container.
 
 These types serve as the backbone for model creation and simplify marshalling
 and unmarshalling.

pyflp/_models.py

@@ -11,7 +11,7 @@
 # GNU General Public License along with this program. If not, see
 # <https://www.gnu.org/licenses/>.
 
-"""Contains the ABCs used by model classes."""
+"""Contains the ABCs used by model classes and some shared classes."""
 
 from __future__ import annotations
 

pyflp/channel.py

@@ -11,7 +11,7 @@
 # GNU General Public License along with this program. If not, see
 # <https://www.gnu.org/licenses/>.
 
-"""Contains the types used by the channels and channel rack."""
+"""Contains the types used by channels and the channel rack."""
 
 from __future__ import annotations
 

pyflp/controller.py

@@ -11,7 +11,7 @@
 # GNU General Public License along with this program. If not, see
 # <https://www.gnu.org/licenses/>.
 
-"""Contains the types used by MIDI and remote controllers."""
+"""Contains the types used by MIDI and remote ("internal") controllers."""
 
 from __future__ import annotations
 

pyflp/exceptions.py

@@ -79,7 +79,7 @@ def __init__(self, desc: str):
         super().__init__(f"Error parsing header: {desc}")
 
 
-class NoModelsFound(DataCorrupted):
+class NoModelsFound(DataCorrupted, LookupError):
     """Model's `__iter__` method fails to generate any model."""
 
 

pyflp/pattern.py

@@ -11,7 +11,7 @@
 # GNU General Public License along with this program. If not, see
 # <https://www.gnu.org/licenses/>.
 
-"""Contains the types used by MIDI patterns, notes and their automation data."""
+"""Contains the types used by patterns, MIDI notes and their automation data."""
 
 from __future__ import annotations
 

pyflp/plugin.py

@@ -11,7 +11,7 @@
 # GNU General Public License along with this program. If not, see
 # <https://www.gnu.org/licenses/>.
 
-"""Contains the types used by native and VST plugins."""
+"""Contains the types used by native and VST plugins to store their preset data."""
 
 from __future__ import annotations
 

pyflp/project.py

@@ -11,7 +11,7 @@
 # GNU General Public License along with this program. If not, see
 # <https://www.gnu.org/licenses/>.
 
-"""Contains the types used by the public API and other project-wide properties."""
+"""Contains the class (and types it uses) used by the parser and serializer."""
 
 from __future__ import annotations