Skip to content

Commit 8d93533

Browse files
committed
fix doc
1 parent edc54c8 commit 8d93533

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Doc/c-api/iter.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ There are two functions specifically for working with iterators.
2727
caller to check this).
2828
If there are no remaining values, set ``*item`` to ``NULL``.
2929
30-
Return 0 on success and -1 on error.
30+
Return 1 if an item was returned from the iterator, 0 if the iterator
31+
is exhausted, and -1 on error.
3132
3233
To write a loop which iterates over an iterator, the C code should look
3334
something like this::

0 commit comments

Comments
 (0)