Get game description docstring from catalog.yml

Author: edwardchalstrey1

src/pygambit/catalog/catalog.py

@@ -204,6 +204,7 @@ def _generate_contrib_game_classes(catalog: dict[str, dict]) -> None:
         class_attrs = {
             "game_file": game_file,
             "__module__": __name__,
+            "__doc__": entry.get("description", None),
         }
 
         # Add metadata fields as class attributes

src/pygambit/catalog/catalog.yml

@@ -334,6 +334,7 @@ Pbride:
   metadata:
 PrisonersDilemma:
   file: pd.nfg
+  description: "A simple implementation of a two person Prisoner's Dilemma game."
   metadata:
     test_suite: true
 Perfect1:

tests/test_catalog.py

@@ -59,6 +59,13 @@ def test_catalog_yml_game_instantiation(self):
         """Custom CatalogGame subclasses reading from catalog.yml should return Game instances."""
         assert isinstance(PrisonersDilemma(), Game)
 
+    def test_catalog_yml_game_description(self):
+        """Custom CatalogGame subclasses reading from catalog.yml should return Game instances."""
+        assert (
+            PrisonersDilemma.description
+            == "A simple implementation of a two person Prisoner's Dilemma game."
+        )
+
 
 class TestGamesFunction:
     """Tests for the games() query function."""