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

Add illustrations for "merge" & "zip" operators #255

Open
gatamar opened this issue Apr 23, 2022 · 2 comments
Open

Add illustrations for "merge" & "zip" operators #255

gatamar opened this issue Apr 23, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@gatamar
Copy link
Contributor

gatamar commented Apr 23, 2022

While the description of these operators is very good, it would be nice to have also the illustrations.

Operators:

Instructions:

  • swiftui-notes/marbles/README.md

Output:

  • svg files added to swiftui-notes/docs/images/diagrams
  • reference.adoc file updated with a reference to an image
  • reference.adoc files updated for each localisation
@heckj heckj added the enhancement New feature or request label Apr 23, 2022
@heckj
Copy link
Owner

heckj commented Apr 23, 2022

These are both good ideas - I gave up on the automated marble diagrams after trying them, and was hand-creating the diagrams that I used in this content using OmniGraffle and then exporting the content to individual SVG files.

And if you're not already aware of them, the "next generation" of this kind of code for swift (swift-async-algorithms) is being developed in the open by the Apple team and open source contributors, and most especially has lovely detailed guides of what each algorithm does, how they're naming it, and why and how it's different from the other algorithms (at https://github.com/apple/swift-async-algorithms/tree/main/Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides). All of which didn't happen originally with Combine (and hence my cobbling all the tests and writing for this content).

@heckj
Copy link
Owner

heckj commented Apr 23, 2022

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

No branches or pull requests

2 participants