Rename Game.comment to Game.description#755
Merged
Conversation
4 tasks
tturocy
requested changes
Feb 5, 2026
Member
tturocy
left a comment
tturocy
left a comment
There was a problem hiding this comment.
In the AGG and BAGG file format, the "comments" are literally comments just like in source code (the # character makes everything until EOL a comment which is ignored). So those shouldn't be changed.
We should add a ChangeLog entry, and possibly a versionchanged in the docstring for the property in Python.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of the changes in this PR
This PR renames
Game.commenttoGame.descriptionas well as renaming associated functions across the codebase. Motivation behind this comes from development of the Gambit catalog of games, where we may want to encourage (or enforce) all/most games to have an extended description as well as a basic title.How to review this PR