From 97af56bd550f25f2a208c0910256133ec9e7fc58 Mon Sep 17 00:00:00 2001 From: Alexander Clark Date: Wed, 2 Jul 2025 12:37:54 -0700 Subject: [PATCH] Add module docstrings --- freeride/__init__.py | 2 ++ freeride/affine.py | 2 ++ freeride/base.py | 2 ++ freeride/curves.py | 2 ++ freeride/exceptions.py | 2 ++ freeride/quadratic.py | 2 ++ run_notebooks.py | 2 ++ 7 files changed, 14 insertions(+) diff --git a/freeride/__init__.py b/freeride/__init__.py index f13cc3b..3fb02fb 100644 --- a/freeride/__init__.py +++ b/freeride/__init__.py @@ -1,3 +1,5 @@ +"""Expose the package version and core FreeRide classes.""" + # FreeRide __version__ = '0.1.1' diff --git a/freeride/affine.py b/freeride/affine.py index 9248c15..a639e92 100644 --- a/freeride/affine.py +++ b/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 diff --git a/freeride/base.py b/freeride/base.py index ac2f714..4d24b4a 100644 --- a/freeride/base.py +++ b/freeride/base.py @@ -1,3 +1,5 @@ +"""Base class for polynomial functions used in FreeRide.""" + import numbers from collections.abc import Iterable diff --git a/freeride/curves.py b/freeride/curves.py index 851b8b0..a6eaa7b 100644 --- a/freeride/curves.py +++ b/freeride/curves.py @@ -1,3 +1,5 @@ +"""Implement demand, supply and related curves.""" + import numpy as np import matplotlib.pyplot as plt import warnings diff --git a/freeride/exceptions.py b/freeride/exceptions.py index 1aec1ba..223a671 100644 --- a/freeride/exceptions.py +++ b/freeride/exceptions.py @@ -1,3 +1,5 @@ +"""Define FreeRide-specific exception classes.""" + from typing import Optional diff --git a/freeride/quadratic.py b/freeride/quadratic.py index 510acf1..a91f4ca 100644 --- a/freeride/quadratic.py +++ b/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 diff --git a/run_notebooks.py b/run_notebooks.py index 5478f9f..06a2683 100644 --- a/run_notebooks.py +++ b/run_notebooks.py @@ -1,3 +1,5 @@ +"""Execute notebooks in the project directory.""" + import papermill as pm import os