doc

Author: dweindl

petab/v1/distributions.py

@@ -1,4 +1,13 @@
-"""Probability distributions used by PEtab."""
+"""Probability distributions used by PEtab.
+
+This module provides a set of univariate probability distributions
+that can be used for sampling and evaluating the probability density
+function (PDF) and cumulative distribution function (CDF).
+Most of these distributions also support log transformations and truncation.
+
+Not all distributions that can be represented by these classes are valid
+as PEtab parameter prior or noise distributions.
+"""
 
 from __future__ import annotations
 

petab/v2/core.py

@@ -973,6 +973,7 @@ def prior_dist(self) -> Distribution:
             log = False
 
         if cls == Exponential:
+            # `Exponential.__init__` does not accept the `log` parameter
             if log is not False:
                 raise ValueError(
                     "Exponential distribution does not support log "