Typos and changelog

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) (+ the Migration Guide),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.34.0] - 
+
+### Added
+
+- Dataset classes are now generic and allow you to provide the group-label tuple as generic. This allows for better type 
+  checking and IDE support. (https://github.com/mad-lab-fau/tpcp/pull/113)
+
 ## [0.33.1] - 2024-06-14
 
 - Only warning about global caching once.
@@ -22,7 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.32.0] - 2024-04-17
 
 - The snapshot plugin now supports a new command line argument `--snapshot-only-check` that will fail the test if no
-  snapshot file is found. This is usefull for CI/CD pipelines, where you want to ensure that all snapshots are up to 
+  snapshot file is found. This is useful for CI/CD pipelines, where you want to ensure that all snapshots are up to 
   date.
 - The snapshot plugin is now installed automatically when you install tpcp. There is no need to set it up in the conftest
   file anymore.

examples/datasets/_01_datasets_basics.py

@@ -239,7 +239,7 @@ def create_index(self):
 # data access.
 # It comes down to documentation to ensure that users access the data in the correct way.
 #
-# In general we try to follow a couple of conventions to give datasets a consistent feel:
+# In general, we try to follow a couple of conventions to give datasets a consistent feel:
 #
 # - Data access should be provided via `@property` decorator on the dataset objects, loading the data on demand.
 # - The names of these properties should follow some the naming scheme (e.g. `data` for the core sensor data)

examples/datasets/_02_datasets_real_world_example.py

@@ -299,12 +299,13 @@ def create_index(self) -> pd.DataFrame:
 # Advanced Concepts - Typing Group Labels
 # ---------------------------------------
 # In the example above, your IDE will assume that the grouplabel you get from the dataset is a simple tuple of strings.
+# Try it out by running this example and attempt to auto-complete the group label keys.
 
 group_label = dataset[0].group_label
 group_label
 
 # %%
-# However, in reality, it is a NamedTuple with derived by pandas based on the columns of your index.
+# However, in reality, it is a NamedTuple which is derived by pandas based on the columns of your index.
 # That allows named access to the group label.
 group_label.participant