swiftui-notes icon indicating copy to clipboard operation
swiftui-notes copied to clipboard

Add illustrations for "merge" & "zip" operators

Open gatamar opened this issue 2 years ago • 2 comments

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

Operators:

  • https://heckj.github.io/swiftui-notes/#reference-merge
  • https://heckj.github.io/swiftui-notes/#reference-zip

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

gatamar avatar Apr 23 '22 15:04 gatamar

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 avatar Apr 23 '22 17:04 heckj