doc: add file-scope docstrings to dissipation module

sy-cui · Oct 10, 2024 · b6d748a · b6d748a
1 parent 90f3a72
commit b6d748a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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
@@ -1,3 +1,4 @@
+__doc__ = """Laplacian dissipation filter implementation"""
 from typing import Any
 
 import numpy as np