Document All The Things

[CodaFi]

• [x] Break up large sections with Marks.
• [x] Clarify pipes terminology (Producer, Consumer, Pipe, Effect, Client, Server).
• [x] Document Operators properly.
• [x] Document Group Producer properly.
• [x] Diagrams, Diagrams, Diagrams

[CodaFi]

I'm unclear on a few of the operators here. Specifically

|<| and >|>

[pthariensflame]

@CodaFi Those could probably stand to be renamed. :P

The correspondence between operator names in Aquifer and pipes is as close as I could possibly make it, but some of the original pipes operators (specifically, those containing \ or / characters) had to be renamed due to limitations of Swift syntax.

[CodaFi]

Ja, that I totally understand. I was wondering, specifically, which operators they mapped to.

[pthariensflame]

I just went through the code and I actually can't figure out the some of the operator name correspondences myself, which is, I guess, yet more evidence of how terrible they are. I swear they made sense to me at the time! :(

[pthariensflame]

Any suggestions for a better name correspondence? We need the following operators to have Swift-ier names (each pair should remain a pair):

• //> and <\\
• >\\ and //<
• />/ and \<\
• \>\ and /</

[CodaFi]

I think you did a fine job with the first two just converting the slashes to pipes. The last couple I'm not sure of... Swift won't take any of those, and there's a duplication problem if you just convert to |>| and|<|. Unless you're cool with overloading here?

[pthariensflame]

I would rather not overload here, even if Swift allows it, because it would be confusing for the user as to which overload of each operator applied where. Both of those pairs are used on Proxy Kleisli morphisms, so it would be very hard to tell what a given piece of code did if they were overloaded.

[CodaFi]

I'm happy with this for now. Capping changes here.

Ready for review.

[pthariensflame]

Other than the mentioned nitpicks, this looks good!

[CodaFi]

There, that should do it.

[pthariensflame]

You missed a single thing. :)

[CodaFi]

Not anymore :sparkle:

[CodaFi]

終わりますか？

[pthariensflame]

Sí, ahora esta bien. :)

[CodaFi]

凄い！

You have the bridge

[pthariensflame]

Thank you, First.

[CodaFi]

:sparkles:

[pthariensflame]

:heart: