async-rs / async-rs/async-std

async_std::stream::Pending and async_std::stream::pending() are not documented as unstable items

Open
#949 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
4.1k
Forks
339
PR merge metrics
No merged PRs in 30d

Description

The `stream::pending` module is only exported for the "unstable" feature: https://github.com/async-rs/async-std/blob/4d9499c27751aa47bcd1c8f1cb0e56ee9a2e338b/src/stream/mod.rs#L328, but these items are not documented to require the feature in the docs like they are for other unstable functions/types: https://docs.rs/async-std/1.9.0/async_std/stream/index.html#traits.

Contributor guide

Open the contributing guide

Research direction

Start with src/stream/mod.rs at the stream::pending module export, then compare its documentation with the other unstable functions and types shown in the docs.rs stream index. Update the pending module and item documentation so the unstable feature requirement is visible, then verify the generated documentation reflects that requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.