update comment functions across codebase to be description functions

edwardchalstrey1 · edwardchalstrey1 · commit 330ba3c90de2 · 2026-02-04T09:58:31.000Z
diff --git a/src/games/agg/agg.cc b/src/games/agg/agg.cc
@@ -116,14 +116,14 @@ AGG::AGG(int numPlayers, std::vector<int> &_actions, int numANodes, int _numPNod
 
 namespace {
 
-void stripComment(istream &in)
+void stripDescription(istream &in)
 {
   in >> ws;
   const char c = in.peek();
   stringbuf discard(ios_base::out);
   if (c == AGG::COMMENT_CHAR) {
     in.get(discard);
-    stripComment(in);
+    stripDescription(in);
   }
 }
 
@@ -137,22 +137,22 @@ std::shared_ptr<AGG> AGG::makeAGG(istream &in)
   if (!in.good() || in.eof()) {
     throw std::runtime_error("Bad game file");
   }
-  stripComment(in);
+  stripDescription(in);
   in >> n;
   if (!in.good()) {
     throw std::runtime_error("Error reading the number of players");
   }
-  stripComment(in);
+  stripDescription(in);
   in >> S;
   if (!in.good()) {
     throw std::runtime_error("Error reading the number of action nodes");
   }
-  stripComment(in);
+  stripDescription(in);
   in >> P;
   if (!in.good()) {
     throw std::runtime_error("Error reading the number of function nodes");
   }
-  stripComment(in);
+  stripDescription(in);
 
   // enter sizes of action sets:
   std::vector<int> size(n);
@@ -165,10 +165,10 @@ std::shared_ptr<AGG> AGG::makeAGG(istream &in)
     }
   }
 
-  stripComment(in);
+  stripDescription(in);
   vector<vector<int>> ASets(n); // action sets
   for (i = 0; i < n; i++) {
-    stripComment(in);
+    stripDescription(in);
     for (j = 0; j < size[i]; j++) {
       int aindex;
       in >> aindex;
@@ -181,10 +181,10 @@ std::shared_ptr<AGG> AGG::makeAGG(istream &in)
     }
   }
 
-  stripComment(in);
+  stripDescription(in);
   vector<vector<int>> neighb(S + P); // neighbor lists
   for (i = 0; i < S + P; i++) {
-    stripComment(in);
+    stripDescription(in);
     in >> neighb_size;
     if (in.eof() || in.fail()) {
       throw std::runtime_error(
@@ -202,12 +202,12 @@ std::shared_ptr<AGG> AGG::makeAGG(istream &in)
     }
   }
 
-  stripComment(in);
+  stripDescription(in);
   // enter the projection types:
   vector<projtype> projTypes(P);
   for (i = 0; i < P; ++i) {
     int pt;
-    stripComment(in);
+    stripDescription(in);
     in >> pt;
     if (in.eof() || in.fail()) {
       throw std::runtime_error("Error in game file: expected integer for type of function node #" +
@@ -259,13 +259,13 @@ std::shared_ptr<AGG> AGG::makeAGG(istream &in)
     }
   }
 
-  stripComment(in);
+  stripDescription(in);
   // read in payoffs
   for (i = 0; i < S; i++) {
     if (in.eof() || in.bad()) {
       throw std::runtime_error("Error in game file: not enough payoffs");
     }
-    stripComment(in);
+    stripDescription(in);
     int t;
     in >> t;
     if (!in.good()) {
@@ -807,7 +807,7 @@ void AGG::makeMAPPINGpayoff(std::istream &in, aggpayoff &pay, int numNei)
   temp = pay;
   pay.clear();
 
-  stripComment(in);
+  stripDescription(in);
   in >> num;
   if (!in.good()) {
     throw std::runtime_error("Error reading the integer number of configuration-value pairs");
diff --git a/src/games/agg/bagg.cc b/src/games/agg/bagg.cc
@@ -48,7 +48,7 @@ BAGG::BAGG(int N, int S, vector<int> &numTypes, vector<ProbDist> &TDist,
 
 namespace {
 
-void stripComment(istream &in)
+void stripDescription(istream &in)
 {
   const char COMMENT_CHAR = '#';
 
@@ -57,7 +57,7 @@ void stripComment(istream &in)
   stringbuf discard(ios_base::out);
   if (c == COMMENT_CHAR) {
     in.get(discard);
-    stripComment(in);
+    stripDescription(in);
   }
 }
 
@@ -67,14 +67,14 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)
 {
   int N, S, P;
 
-  stripComment(in);
+  stripDescription(in);
   in >> N;
-  stripComment(in);
+  stripDescription(in);
   in >> S;
-  stripComment(in);
+  stripDescription(in);
   in >> P;
 
-  stripComment(in);
+  stripDescription(in);
   vector<int> numTypes(N);
 
   // input number of types for each player
@@ -88,7 +88,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)
   }
 
   // input the type distributions
-  stripComment(in);
+  stripDescription(in);
   vector<ProbDist> TDist;
   for (int i = 0; i < N; ++i) {
     TDist.emplace_back(numTypes[i]);
@@ -100,7 +100,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)
     }
   }
 
-  stripComment(in);
+  stripDescription(in);
   // sizes of type action sets
   vector<vector<vector<int>>> typeActionSets(N);
   for (int i = 0; i < N; ++i) {
@@ -116,7 +116,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)
   }
 
   // type action sets
-  stripComment(in);
+  stripDescription(in);
   for (int i = 0; i < N; ++i) {
     for (int j = 0; j < numTypes[i]; ++j) {
       for (int &el : typeActionSets[i][j]) {
@@ -127,7 +127,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)
       }
     }
   }
-  stripComment(in);
+  stripDescription(in);
 
   // action sets
   vector<vector<int>> aggActionSets;
diff --git a/src/games/file.cc b/src/games/file.cc
@@ -440,7 +440,7 @@ Game BuildNfg(GameFileLexer &p_parser, TableFileGame &p_data)
   // If this looks lke an outcome-based format, then don't create outcomes in advance
   Game nfg = NewTable(p_data.NumStrategies(), p_parser.GetCurrentToken() == TOKEN_LBRACE);
   nfg->SetTitle(p_data.m_title);
-  nfg->SetComment(p_data.m_comment);
+  nfg->SetDescription(p_data.m_comment);
 
   for (auto player : nfg->GetPlayers()) {
     player->SetLabel(p_data.GetPlayer(player->GetNumber()));
@@ -865,7 +865,7 @@ Game ReadEfgFile(std::istream &p_stream, bool p_normalizeLabels /* = false */)
   ReadPlayers(parser, game, treeData);
   if (parser.GetNextToken() == TOKEN_TEXT) {
     // Read optional comment
-    game->SetComment(parser.GetLastText());
+    game->SetDescription(parser.GetLastText());
     parser.GetNextToken();
   }
   ParseNode(parser, game, game->GetRoot(), treeData);
diff --git a/src/games/game.cc b/src/games/game.cc
@@ -229,7 +229,7 @@ void GameRep::WriteNfgFile(std::ostream &p_file) const
     }) << std::endl;
   }
   p_file << "}" << std::endl;
-  p_file << std::quoted(GetComment()) << std::endl << std::endl;
+  p_file << std::quoted(GetDescription()) << std::endl << std::endl;
 
   for (auto iter : StrategyContingencies(
            StrategySupportProfile(std::const_pointer_cast<GameRep>(shared_from_this())))) {
diff --git a/src/games/game.h b/src/games/game.h
@@ -888,9 +888,9 @@ class GameRep : public std::enable_shared_from_this<GameRep> {
   virtual void SetTitle(const std::string &p_title) { m_title = p_title; }
 
   /// Get the text comment associated with the game
-  virtual const std::string &GetComment() const { return m_comment; }
+  virtual const std::string &GetDescription() const { return m_comment; }
   /// Set the text comment associated with the game
-  virtual void SetComment(const std::string &p_comment) { m_comment = p_comment; }
+  virtual void SetDescription(const std::string &p_comment) { m_comment = p_comment; }
 
   /// Return the version number of the game.  The version is incremented after each
   /// substantive change to the game (i.e. not merely involving labels)
diff --git a/src/games/gametable.cc b/src/games/gametable.cc
@@ -469,7 +469,7 @@ void GameTableRep::WriteNfgFile(std::ostream &p_file) const
     }) << std::endl;
   }
   p_file << "}" << std::endl;
-  p_file << std::quoted(GetComment()) << std::endl << std::endl;
+  p_file << std::quoted(GetDescription()) << std::endl << std::endl;
 
   p_file << "{" << std::endl;
   for (auto outcome : m_outcomes) {
diff --git a/src/games/gametree.cc b/src/games/gametree.cc
@@ -1196,7 +1196,7 @@ void GameTreeRep::WriteEfgFile(std::ostream &p_file, const GameNode &p_subtree /
          << FormatList(GetPlayers(),
                        [](const GamePlayer &p) { return QuoteString(p->GetLabel()); })
          << std::endl;
-  p_file << std::quoted(GetComment()) << std::endl << std::endl;
+  p_file << std::quoted(GetDescription()) << std::endl << std::endl;
   Gambit::WriteEfgFile(p_file, (p_subtree) ? p_subtree : GetRoot());
 }
 
diff --git a/src/games/stratspt.cc b/src/games/stratspt.cc
@@ -100,7 +100,7 @@ void StrategySupportProfile::WriteNfgFile(std::ostream &p_file) const
     }) << std::endl;
   }
   p_file << "}" << std::endl;
-  p_file << std::quoted(m_game->GetComment()) << std::endl << std::endl;
+  p_file << std::quoted(m_game->GetDescription()) << std::endl << std::endl;
 
   for (const auto &iter : StrategyContingencies(*this)) {
     p_file << FormatList(
diff --git a/src/gui/dlgameprop.cc b/src/gui/dlgameprop.cc
@@ -51,7 +51,7 @@ GamePropertiesDialog::GamePropertiesDialog(wxWindow *p_parent, GameDocument *p_d
   commentSizer->Add(new wxStaticText(this, wxID_STATIC, _("Comment")), 0, wxALL | wxALIGN_CENTER,
                     5);
   m_comment = new wxTextCtrl(this, wxID_ANY,
-                             wxString(m_doc->GetGame()->GetComment().c_str(), *wxConvCurrent),
+                             wxString(m_doc->GetGame()->GetDescription().c_str(), *wxConvCurrent),
                              wxDefaultPosition, wxSize(400, -1), wxTE_MULTILINE);
   commentSizer->Add(m_comment, 1, wxALL | wxALIGN_CENTER, 5);
   topSizer->Add(commentSizer, 1, wxALL | wxEXPAND, 0);
diff --git a/src/gui/dlgameprop.h b/src/gui/dlgameprop.h
@@ -34,7 +34,7 @@ class GamePropertiesDialog final : public wxDialog {
 
   // Data access (only valid when ShowModal() returns with wxID_OK)
   wxString GetTitle() const override { return m_title->GetValue(); }
-  wxString GetComment() const { return m_comment->GetValue(); }
+  wxString GetDescription() const { return m_comment->GetValue(); }
 };
 
 } // namespace Gambit::GUI
diff --git a/src/gui/gamedoc.cc b/src/gui/gamedoc.cc
@@ -406,7 +406,7 @@ void GameDocument::DoExportNfg(const wxString &p_filename)
 void GameDocument::DoSetTitle(const wxString &p_title, const wxString &p_comment)
 {
   m_game->SetTitle(static_cast<const char *>(p_title.mb_str()));
-  m_game->SetComment(static_cast<const char *>(p_comment.mb_str()));
+  m_game->SetDescription(static_cast<const char *>(p_comment.mb_str()));
   UpdateViews(GBT_DOC_MODIFIED_LABELS);
 }
 
diff --git a/src/gui/gameframe.cc b/src/gui/gameframe.cc
@@ -1058,7 +1058,7 @@ void GameFrame::OnEditGame(wxCommandEvent &)
 {
   GamePropertiesDialog dialog(this, m_doc);
   if (dialog.ShowModal() == wxID_OK) {
-    m_doc->DoSetTitle(dialog.GetTitle(), dialog.GetComment());
+    m_doc->DoSetTitle(dialog.GetTitle(), dialog.GetDescription());
   }
 }
 
diff --git a/src/pygambit/gambit.pxd b/src/pygambit/gambit.pxd
@@ -253,8 +253,8 @@ cdef extern from "games/game.h":
         string GetTitle() except +
         void SetTitle(string) except +
 
-        string GetComment() except +
-        void SetComment(string) except +
+        string GetDescription() except +
+        void SetDescription(string) except +
 
         int NumPlayers() except +
         c_GamePlayer GetPlayer(int) except +IndexError
diff --git a/src/pygambit/game.pxi b/src/pygambit/game.pxi
@@ -667,11 +667,11 @@ class Game:
         A game's description is an arbitrary string, and may be more discursive
         than a title.
         """
-        return self.game.deref().GetComment().decode("ascii")
+        return self.game.deref().GetDescription().decode("ascii")
 
     @description.setter
     def description(self, value: str) -> None:
-        self.game.deref().SetComment(value.encode("ascii"))
+        self.game.deref().SetDescription(value.encode("ascii"))
 
     @property
     def actions(self) -> GameActions:

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ BAGG::BAGG(int N, int S, vector<int> &numTypes, vector<ProbDist> &TDist,`
`48`	`48`
`49`	`49`	`namespace {`
`50`	`50`
`51`		`-void stripComment(istream &in)`
	`51`	`+void stripDescription(istream &in)`
`52`	`52`	`{`
`53`	`53`	`const char COMMENT_CHAR = '#';`
`54`	`54`
`@@ -57,7 +57,7 @@ void stripComment(istream &in)`
`57`	`57`	`stringbuf discard(ios_base::out);`
`58`	`58`	`if (c == COMMENT_CHAR) {`
`59`	`59`	`in.get(discard);`
`60`		`- stripComment(in);`
	`60`	`+ stripDescription(in);`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`@@ -67,14 +67,14 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)`
`67`	`67`	`{`
`68`	`68`	`int N, S, P;`
`69`	`69`
`70`		`- stripComment(in);`
	`70`	`+ stripDescription(in);`
`71`	`71`	`in >> N;`
`72`		`- stripComment(in);`
	`72`	`+ stripDescription(in);`
`73`	`73`	`in >> S;`
`74`		`- stripComment(in);`
	`74`	`+ stripDescription(in);`
`75`	`75`	`in >> P;`
`76`	`76`
`77`		`- stripComment(in);`
	`77`	`+ stripDescription(in);`
`78`	`78`	`vector<int> numTypes(N);`
`79`	`79`
`80`	`80`	`// input number of types for each player`
`@@ -88,7 +88,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`// input the type distributions`
`91`		`- stripComment(in);`
	`91`	`+ stripDescription(in);`
`92`	`92`	`vector<ProbDist> TDist;`
`93`	`93`	`for (int i = 0; i < N; ++i) {`
`94`	`94`	`TDist.emplace_back(numTypes[i]);`
`@@ -100,7 +100,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)`
`100`	`100`	`}`
`101`	`101`	`}`
`102`	`102`
`103`		`- stripComment(in);`
	`103`	`+ stripDescription(in);`
`104`	`104`	`// sizes of type action sets`
`105`	`105`	`vector<vector<vector<int>>> typeActionSets(N);`
`106`	`106`	`for (int i = 0; i < N; ++i) {`
`@@ -116,7 +116,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`// type action sets`
`119`		`- stripComment(in);`
	`119`	`+ stripDescription(in);`
`120`	`120`	`for (int i = 0; i < N; ++i) {`
`121`	`121`	`for (int j = 0; j < numTypes[i]; ++j) {`
`122`	`122`	`for (int &el : typeActionSets[i][j]) {`
`@@ -127,7 +127,7 @@ std::shared_ptr<BAGG> BAGG::makeBAGG(istream &in)`
`127`	`127`	`}`
`128`	`128`	`}`
`129`	`129`	`}`
`130`		`- stripComment(in);`
	`130`	`+ stripDescription(in);`
`131`	`131`
`132`	`132`	`// action sets`
`133`	`133`	`vector<vector<int>> aggActionSets;`
Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ void GameRep::WriteNfgFile(std::ostream &p_file) const`
`229`	`229`	`}) << std::endl;`
`230`	`230`	`}`
`231`	`231`	`p_file << "}" << std::endl;`
`232`		`- p_file << std::quoted(GetComment()) << std::endl << std::endl;`
	`232`	`+ p_file << std::quoted(GetDescription()) << std::endl << std::endl;`
`233`	`233`
`234`	`234`	`for (auto iter : StrategyContingencies(`
`235`	`235`	`StrategySupportProfile(std::const_pointer_cast<GameRep>(shared_from_this())))) {`
Original file line number	Diff line number	Diff line change
`@@ -469,7 +469,7 @@ void GameTableRep::WriteNfgFile(std::ostream &p_file) const`
`469`	`469`	`}) << std::endl;`
`470`	`470`	`}`
`471`	`471`	`p_file << "}" << std::endl;`
`472`		`- p_file << std::quoted(GetComment()) << std::endl << std::endl;`
	`472`	`+ p_file << std::quoted(GetDescription()) << std::endl << std::endl;`
`473`	`473`
`474`	`474`	`p_file << "{" << std::endl;`
`475`	`475`	`for (auto outcome : m_outcomes) {`
Original file line number	Diff line number	Diff line change
`@@ -1196,7 +1196,7 @@ void GameTreeRep::WriteEfgFile(std::ostream &p_file, const GameNode &p_subtree /`
`1196`	`1196`	`<< FormatList(GetPlayers(),`
`1197`	`1197`	`[](const GamePlayer &p) { return QuoteString(p->GetLabel()); })`
`1198`	`1198`	`<< std::endl;`
`1199`		`- p_file << std::quoted(GetComment()) << std::endl << std::endl;`
	`1199`	`+ p_file << std::quoted(GetDescription()) << std::endl << std::endl;`
`1200`	`1200`	`Gambit::WriteEfgFile(p_file, (p_subtree) ? p_subtree : GetRoot());`
`1201`	`1201`	`}`
`1202`	`1202`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ void StrategySupportProfile::WriteNfgFile(std::ostream &p_file) const`
`100`	`100`	`}) << std::endl;`
`101`	`101`	`}`
`102`	`102`	`p_file << "}" << std::endl;`
`103`		`- p_file << std::quoted(m_game->GetComment()) << std::endl << std::endl;`
	`103`	`+ p_file << std::quoted(m_game->GetDescription()) << std::endl << std::endl;`
`104`	`104`
`105`	`105`	`for (const auto &iter : StrategyContingencies(*this)) {`
`106`	`106`	`p_file << FormatList(`