Skip to content

Commit 4fa6020

Browse files
committed
Tweak would_block() and empty() docs
1 parent 7c44637 commit 4fa6020

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

chess/engine.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2608,21 +2608,19 @@ def would_block(self) -> bool:
26082608
calling :func:`~chess.engine.AnalysisResult.wait()`, or advancing the
26092609
iterator one step would require waiting for the engine.
26102610
2611-
All of these functions would return immediately information is pending
2612-
(queue is not :func:`empty <chess.engine.AnalysisResult.empty()>`)
2613-
or if the search is finished.
2611+
All of these functions would return immediately if information is
2612+
pending (queue is not
2613+
:func:`empty <chess.engine.AnalysisResult.empty()>`) or if the search
2614+
is finished.
26142615
"""
26152616
return not self._seen_kork and self._queue.empty()
26162617

26172618
def empty(self) -> bool:
26182619
"""
2619-
Checks if all information has been consumed.
2620+
Checks if all current information has been consumed.
26202621
26212622
If the queue is empty, but the analysis is still ongoing, then further
26222623
information can become available in the future.
2623-
2624-
If the queue is not empty, then the next call to
2625-
:func:`~chess.engine.AnalysisResult.get()` will return instantly.
26262624
"""
26272625
return self._seen_kork or self._queue.qsize() <= self._posted_kork
26282626

0 commit comments

Comments
 (0)