Skip to content

Commit a1f16f8

Browse files
committed
Correct documentation of send_game_result method
1 parent 885d59f commit a1f16f8

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

chess/engine.py

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1251,10 +1251,15 @@ async def send_game_result(self, board: chess.Board, winner: Optional[Color] = N
12511251
"""
12521252
Sends the engine the result of the game.
12531253
1254-
UCI engines only recieve the final position of the board. XBoard engines
1255-
receive the final moves and a line of the form "result <winner> {<ending>}",
1256-
where <winner> is one of "1-0", "0-1", "1/2-1/2", or "*" to indicate white
1257-
won, black won, draw, or adjournment, respectively.
1254+
XBoard engines receive the final moves and a line of the form
1255+
"result <winner> {<ending>}". The <winner> field is one of "1-0",
1256+
"0-1", "1/2-1/2", or "*" to indicate white won, black won, draw,
1257+
or adjournment, respectively. The <ending> field is a description
1258+
of the specific reason for the end of the game: "White mates",
1259+
"Time forfeiture", "Stalemate", etc.
1260+
1261+
UCI engines do not expect end-of-game information and so are not
1262+
sent anything.
12581263
12591264
:param board: The final state of the board.
12601265
:param winner: Optional. Specify the winner of the game. This is useful

0 commit comments

Comments
 (0)