docs: rename example temperature sensor and source

Signed-off-by: F.N. Claessen <felix@seita.nl>
SeitaBV · Feb 20, 2025 · 0e97a33 · 0e97a33
1 parent 62e1a76
commit 0e97a33
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/timely_beliefs/docs/init.md b/timely_beliefs/docs/init.md
@@ -77,8 +77,8 @@ An example, adapted from `timely_beliefs/example/__init__.py`:
 
     temperature_df = tb.read_csv(
         "temperature.csv",
-        sensor=tb.Sensor("Thermometer A", unit="°C", event_resolution=timedelta(hours=1)),
-        source=tb.BeliefSource("Source X"),
+        sensor=tb.Sensor("Ambient temperature", unit="°C", event_resolution=timedelta(hours=1)),
+        source=tb.BeliefSource("Thermometer A"),
     )
 
 In case the csv file contains multiple source names, you can pass a list of sources.

diff --git a/timely_beliefs/examples/__init__.py b/timely_beliefs/examples/__init__.py
@@ -13,9 +13,9 @@ def get_temperature_df():
     return tb.read_csv(
         os.path.join(get_examples_path(), "temperature.csv"),
         sensor=tb.Sensor(
-            "Thermometer A", unit="°C", event_resolution=timedelta(hours=1)
+            "Ambient temperature", unit="°C", event_resolution=timedelta(hours=1)
         ),
-        source=tb.BeliefSource("Source X"),
+        source=tb.BeliefSource("Thermometer A"),
     )