use game description field if no docstring is provided

Author: edwardchalstrey1

src/pygambit/catalog/catalog.py

@@ -43,7 +43,7 @@ def _extract_metadata_from_game(cls, game: Game) -> None:
         if cls.__doc__:
             cls.description = inspect.cleandoc(cls.__doc__)
         else:
-            cls.description = game.comment
+            cls.description = game.description
 
     def __init_subclass__(cls, **kwargs):
         """Extract metadata when subclass is defined (if not a file-based game)."""

src/pygambit/game.pxi

@@ -661,16 +661,16 @@ class Game:
         self.game.deref().SetTitle(value.encode("ascii"))
 
     @property
-    def comment(self) -> str:
-        """Get or set the comment of the game.
+    def description(self) -> str:
+        """Get or set the description of the game.
 
-        A game's comment is an arbitrary string, and may be more discursive
+        A game's description/comment is an arbitrary string, and may be more discursive
         than a title.
         """
         return self.game.deref().GetComment().decode("ascii")
 
-    @comment.setter
-    def comment(self, value: str) -> None:
+    @description.setter
+    def description(self, value: str) -> None:
         self.game.deref().SetComment(value.encode("ascii"))
 
     @property

tests/test_catalog.py

@@ -5,21 +5,27 @@
 
 
 class ExampleGame(CatalogGame):
-    """
-    Test game description.
-    """
 
     game_type = "efg"
 
     @staticmethod
     def _game(some_param: bool = False):
         if some_param:
-            return Game.new_tree(
+            g = Game.new_tree(
                 players=["A", "B"], title="Test game T"
             )
-        return Game.new_tree(
-            players=["A", "B"], title="Test game F"
-        )
+        else:
+            g = Game.new_tree(
+                players=["A", "B"], title="Test game F"
+            )
+        g.description = "Test game description."
+        return g
+
+
+class ExampleGameWithDocstring(ExampleGame):
+    """
+    Alternative test game description.
+    """
 
 
 class TestCatalogGame:
@@ -37,6 +43,10 @@ def test_custom_game_subclass_extracts_metadata(self):
         assert ExampleGame.title == "Test game F"
         assert ExampleGame.description == "Test game description."
 
+    def test_can_get_game_description_from_docstring(self):
+        """CatalogGame should get description from docstring over game description."""
+        assert ExampleGameWithDocstring.description == "Alternative test game description."
+
     def test_catalog_py_game_with_parameters(self):
         """
         Custom CatalogGame subclass should return Game