Skip to content

Provide doc comments for AsyncSequence and related types (for release branch) #37420

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

Merged
merged 1 commit into from
May 14, 2021

Conversation

invalidname
Copy link
Contributor

Source documentation for AsyncSequence, its helper types, and extension methods. (Already landed to main in #37383, this is a cherry-pick to release/5.5).

* First draft docs for iterator, sequence type.

Also drop(while:), to get a feel for the AsyncSequence->AsyncSequence cases.

* Source docs for contains and reduce.

* Docs for methods in AsyncSequence.

This covers all the methods that return a single value. Still working on the extension methods that return new sequences.

* Early source docs for dropFirst(_:) and its type

* Correct doc format for dropFirst(_:).

* Prefix, plus some fixes.

* Docs for prefix(while:).

* Apply Philippe's snippet fixes.

* First draft docs on the map sequences.

Plus miscellaneous fixes throughout.

* Show result of flatMap example.

* More explicit cancellation guidance.

* Convert snippets to trailing closures.

* Correct misplaced doc comments.

* Apply suggestions from code review

Co-authored-by: Philippe Hausler <[email protected]>

* Apply editorial feedback.

* Apply additional editorial feedback.

* Apply suggestions from code review

Co-authored-by: bjlanier <[email protected]>

* Apply further editorial feedback.

Co-authored-by: Chris Adamson <[email protected]>
Co-authored-by: Philippe Hausler <[email protected]>
Co-authored-by: bjlanier <[email protected]>
@invalidname invalidname requested review from phausler and bjlanier May 14, 2021 14:25
@invalidname
Copy link
Contributor Author

@swift-ci please clean smoke test

@invalidname invalidname changed the title Provide doc comments for AsyncSequence and related types (#37383) Provide doc comments for AsyncSequence and related types, release (#37383) May 14, 2021
@invalidname invalidname changed the title Provide doc comments for AsyncSequence and related types, release (#37383) Provide doc comments for AsyncSequence and related types (for release branch) May 14, 2021
@invalidname
Copy link
Contributor Author

@swift-ci please test

@tkremenek tkremenek merged commit b51e3c8 into release/5.5 May 14, 2021
@tkremenek tkremenek deleted the asyncsequence_doc_comments_release_76419461 branch May 14, 2021 20:19
@swift-ci
Copy link
Contributor

Build failed
Swift Test Linux Platform
Git Sha - 885d2e4

@swift-ci
Copy link
Contributor

Build failed
Swift Test OS X Platform
Git Sha - 885d2e4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants