apple / apple/swift-async-algorithms

README and Guides are missing docs for `buffer(policy:)`

Open
#300 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Swift
Stars
3.7k
Forks
226
Avg merge
10d 3h
Merged PRs (30d)
1

Description

I think the README file should be include a comprehensive table of contents to this library, however at least `buffer(policy:)` is currently not listed there, and there is no DocC chapter to be found under [Guides](https://github.com/apple/swift-async-algorithms/tree/main/Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides) either.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the README and the Guides directory under Sources/AsyncAlgorithms/AsyncAlgorithms.docc, then locate the documentation for buffer(policy:). Done means the API appears in the README's library contents and has a corresponding DocC guide entry.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.