From b6d748a74fb62c0113b58c93d4dfce734f20fbdc Mon Sep 17 00:00:00 2001 From: Songyuan Cui Date: Thu, 10 Oct 2024 16:14:53 -0500 Subject: [PATCH] doc: add file-scope docstrings to dissipation module --- elastica/dissipation/__init__.py | 4 ++-- elastica/dissipation/analytical_linear_damper.py | 1 + elastica/dissipation/damper_base.py | 1 + elastica/dissipation/laplacian_dissipation_filter.py | 1 + 4 files changed, 5 insertions(+), 2 deletions(-) diff --git a/elastica/dissipation/__init__.py b/elastica/dissipation/__init__.py index a9ddd44d..a7d2e9a2 100644 --- a/elastica/dissipation/__init__.py +++ b/elastica/dissipation/__init__.py @@ -1,7 +1,7 @@ __doc__ = """ -(added in version 0.3.0) +(added in version 0.3.3) -Built in damper module implementations +Built-in damper module implementations """ from .damper_base import DamperBase diff --git a/elastica/dissipation/analytical_linear_damper.py b/elastica/dissipation/analytical_linear_damper.py index 81ff9f2c..ad0187f9 100644 --- a/elastica/dissipation/analytical_linear_damper.py +++ b/elastica/dissipation/analytical_linear_damper.py @@ -1,3 +1,4 @@ +__doc__ = """Analytical linear damper implementation""" import logging from typing import Any, Callable, TypeAlias diff --git a/elastica/dissipation/damper_base.py b/elastica/dissipation/damper_base.py index 264a1d59..75bbb828 100644 --- a/elastica/dissipation/damper_base.py +++ b/elastica/dissipation/damper_base.py @@ -1,3 +1,4 @@ +__doc__ = """Abstract base class for all damper/dissipation modules""" from abc import ABC, abstractmethod from typing import Any, Generic, TypeVar import numpy as np diff --git a/elastica/dissipation/laplacian_dissipation_filter.py b/elastica/dissipation/laplacian_dissipation_filter.py index 66c6e913..4f75ea8a 100644 --- a/elastica/dissipation/laplacian_dissipation_filter.py +++ b/elastica/dissipation/laplacian_dissipation_filter.py @@ -1,3 +1,4 @@ +__doc__ = """Laplacian dissipation filter implementation""" from typing import Any import numpy as np