Skip to content

Commit

Permalink
Fix would_block() docs (#889)
Browse files Browse the repository at this point in the history
  • Loading branch information
niklasf committed Jun 9, 2022
1 parent b93b2da commit d9cee54
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions chess/engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -2574,7 +2574,7 @@ def stop(self) -> None:
self._stop = None

async def wait(self) -> BestMove:
"""Waits until the analysis is complete (or stopped)."""
"""Waits until the analysis is finished."""
return await self._finished

async def get(self) -> InfoDict:
Expand Down Expand Up @@ -2605,10 +2605,10 @@ def would_block(self) -> bool:
"""
Checks if calling :func:`~chess.engine.AnalysisResult.get()`,
calling :func:`~chess.engine.AnalysisResult.next()`,
calling :func:`~chess.engine.AnalysisResult.wait()`, or advancing the
iterator one step would require waiting for the engine.
or advancing the iterator one step would require waiting for the
engine.
All of these functions would return immediately if information is
These functions would return immediately if information is
pending (queue is not
:func:`empty <chess.engine.AnalysisResult.empty()>`) or if the search
is finished.
Expand Down

0 comments on commit d9cee54

Please sign in to comment.