add docstrings to the diffusion problems (#275)

python-hydro · Sep 15, 2024 · c737549 · c737549
1 parent 1649759
commit c737549
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/pyro/diffusion/problems/gaussian.py b/pyro/diffusion/problems/gaussian.py
@@ -1,3 +1,10 @@
+"""Initialize the profile to a Gaussian.  With a constant
+conductivity, an initial Gaussian profile remains Gaussian, with the
+peak lowering and width increasing with time.  This allows this
+problem to be used for verification.
+
+"""
+
 import numpy
 
 from pyro.util import msg

diff --git a/pyro/diffusion/problems/test.py b/pyro/diffusion/problems/test.py
@@ -1,3 +1,5 @@
+"""A problem setup used for unit testing."""
+
 DEFAULT_INPUTS = None
 
 PROBLEM_PARAMS = {}