From 725048bac331afd83908962ce67852dcd2db727a Mon Sep 17 00:00:00 2001
From: AFg6K7h4fhy2 <127630341+AFg6K7h4fhy2@users.noreply.github.com>
Date: Fri, 12 Apr 2024 10:28:48 -0400
Subject: [PATCH] infections docs edit; latent folder first pass

---
 model/src/pyrenew/latent/infections.py | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/model/src/pyrenew/latent/infections.py b/model/src/pyrenew/latent/infections.py
index b6d9fed1..f5bc2458 100644
--- a/model/src/pyrenew/latent/infections.py
+++ b/model/src/pyrenew/latent/infections.py
@@ -13,16 +13,29 @@
     ["infections"],
     defaults=[None],
 )
+InfectionsSample.__doc__ = """
+A container for holding the output from the InfectionsSample.
+
+Attributes
+----------
+infections : ArrayLike or None
+    The estimated latent infections. Defaults to None. 
+"""
 
 
 class Infections(RandomVariable):
-    """Latent infections"""
+    """Latent infections
+    
+    Methods
+    -------
+    sample(Rt, I0, gen_int, **kwargs)
+    """
 
     def __init__(
         self,
         infections_mean_varname: str = "latent_infections",
     ) -> None:
-        """Default constructor
+        """Default constructor for Infections class. 
 
         Parameters
         ----------
@@ -40,6 +53,11 @@ def __init__(
 
     @staticmethod
     def validate() -> None:
+        """ 
+        Notes
+        -----
+        TODO: Complete this method.
+        """
         return None
 
     def sample(
@@ -61,6 +79,9 @@ def sample(
             Initial infections.
         gen_int : ArrayLike
             Generation interval.
+        **kwargs : dict, optional
+            Additional keyword arguments passed through to internal
+            sample calls, should there be any.
 
         Returns
         -------