Skip to content
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.

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

Update FuturesOrdered docs #2778

Merged
merged 3 commits into from
Oct 9, 2023
Merged

Update FuturesOrdered docs #2778

merged 3 commits into from
Oct 9, 2023

Conversation

zachs18
Copy link
Contributor

@zachs18 zachs18 commented Oct 9, 2023

  • poll -> poll_next
  • push -> push_back (and push_front)
  • Add intra-doc links.

In futures 0.2.0, Stream::poll was renamed to Stream::poll_next, but the docs for FuturesOrdered weren't updated, so they continue to refer to (now nonexistent) FuturesOrdered::poll.

Similarly, FuturesOrdered::push was deprecated at some point, but the docs for FuturesOrdered still mention it ("Futures are submitted to the queue using push").

I also added intra-doc links, of similar frequency as FuturesUnordered has.

Copy link
Member

@taiki-e taiki-e left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@taiki-e taiki-e merged commit a402900 into rust-lang:master Oct 9, 2023
25 checks passed
@taiki-e taiki-e added the docs label Oct 26, 2023
@taiki-e taiki-e mentioned this pull request Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants