]> gitweb.michael.orlitzky.com - dunshire.git/commitdiff
Document a missing parameter for GameUnsolvableExceptions.
authorMichael Orlitzky <michael@orlitzky.com>
Sun, 30 Oct 2016 20:40:32 +0000 (16:40 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Sun, 30 Oct 2016 20:40:32 +0000 (16:40 -0400)
dunshire/errors.py

index b63344a0311e9c843cdeb189c903902de4a2179b..c58a57bdbfdc7c599164684af8590c1308426287 100644 (file)
@@ -49,6 +49,9 @@ class GameUnsolvableException(Exception):
     Parameters
     ----------
 
+    game : SymmetricLinearGame
+        A copy of the game whose solution failed.
+
     solution_dict : dict
         The solution dictionary returned from the failed cone program.
 
@@ -114,7 +117,7 @@ class GameUnsolvableException(Exception):
     """
     def __init__(self, game, solution_dict):
         """
-        Create a new GameUnsolvableException object.
+        Create a new :class:`GameUnsolvableException` object.
         """
         super().__init__()
         self._game = game
@@ -127,7 +130,7 @@ class GameUnsolvableException(Exception):
 
         The returned representation highlights the "status" field of the
         CVXOPT dictionary, since that should explain what went
-        wrong. The game details and full CVXOPT solution dictionary is
+        wrong. The game details and full CVXOPT solution dictionary are
         included after the status.
         """
         tpl = 'Solution failed with result "{:s}."\n' \