Skip to content
Closed
Prev Previous commit
Next Next commit
fix doc
  • Loading branch information
iritkatriel committed Jun 1, 2023
commit 8d93533a71c3f7286136ec87aa8960c3691f99ad
3 changes: 2 additions & 1 deletion Doc/c-api/iter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ There are two functions specifically for working with iterators.
caller to check this).
If there are no remaining values, set ``*item`` to ``NULL``.

Return 0 on success and -1 on error.
Return 1 if an item was returned from the iterator, 0 if the iterator
is exhausted, and -1 on error.

To write a loop which iterates over an iterator, the C code should look
something like this::
Expand Down