New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs referencing old exhausted sentinel value #65

Open

brookslogan wants to merge 1 commit into r-lib:main from brookslogan:complete-exhausted-sentinel-change-doc-update

+6 −6

brookslogan commented Feb 20, 2025

This is a minor documentation fix.

?coro::exhausted currently includes this text:

        • When the iterator is exhausted and there are no more elements
          to return, the symbol 'quote(exhausted)' is returned. This
          signals exhaustion to the caller.

        • Once an iterator has signalled exhaustion, all subsequent
          invokations must consistently return 'coro::exhausted()' or
          'as.symbol(".__exhausted__.")'.

The former bullet point references the old exhausted sentinel value. This PR updates the docs to reference the current sentinel value.


          Update docs referencing old exhausted sentinel value

1914d83

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet