Add concise module docstrings

freeride/__init__.py

@@ -1,3 +1,5 @@
+"""Expose the package version and core FreeRide classes."""
+
 # FreeRide
 __version__ = '0.1.1'
 

freeride/affine.py

@@ -1,3 +1,5 @@
+"""Define affine demand and supply curve utilities."""
+
 import numpy as np
 import matplotlib.pyplot as plt
 from .base import PolyBase

freeride/base.py

@@ -1,3 +1,5 @@
+"""Base class for polynomial functions used in FreeRide."""
+
 import numbers
 from collections.abc import Iterable
 

freeride/curves.py

@@ -1,3 +1,5 @@
+"""Implement demand, supply and related curves."""
+
 import numpy as np
 import matplotlib.pyplot as plt
 import warnings

freeride/exceptions.py

@@ -1,3 +1,5 @@
+"""Define FreeRide-specific exception classes."""
+
 from typing import Optional
 
 

freeride/quadratic.py

@@ -1,3 +1,5 @@
+"""Implement quadratic revenue and cost curve utilities."""
+
 import numpy as np
 import matplotlib.pyplot as plt
 from .base import PolyBase

run_notebooks.py

@@ -1,3 +1,5 @@
+"""Execute notebooks in the project directory."""
+
 import papermill as pm
 import os