QuantEcon / QuantEcon.py / 31922203706

91%

push

github

BUG: Return -1 from best_response_2p instead of falling through to None (#936)

* BUG: Return -1 from best_response_2p instead of falling through to None

When tol < 0, no action satisfies the tolerance condition and the
function fell through to an implicit None despite documenting an int
return. Return -1 in that case, as suggested by oyamad in the review
discussion on #576, and document the behavior.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* DOC: Drop 'must be nonnegative' from best_response_2p tol docs

The Returns section already documents the -1 sentinel for tol < 0, so
the input restriction read as contradictory. Addresses Copilot review
feedback on #936.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* DOC: Frame the -1 return of best_response_2p as an error condition

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* DOC: Restore the nonnegativity stipulation for best_response_2p tol

With -1 now explicitly framed as an error condition in the Returns
section, stating the valid domain in the parameter docs is
complementary rather than contradictory: the parameter doc gives the
precondition, the Returns doc gives the failure mode.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

1 of 1 new or added line in 1 file covered. (100.0%)

5141 of 5674 relevant lines covered (90.61%)

0.91 hits per line