From d5b8c807fe3ce495dbf8c76ac718a7d99a273111 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Sun, 30 Oct 2016 16:40:32 -0400 Subject: [PATCH] Document a missing parameter for GameUnsolvableExceptions. --- dunshire/errors.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/dunshire/errors.py b/dunshire/errors.py index b63344a..c58a57b 100644 --- a/dunshire/errors.py +++ b/dunshire/errors.py @@ -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' \ -- 2.43.2