Add symbols to FAQ #1573
Add symbols to FAQ #1573
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1573 +/- ##
=======================================
Coverage 93.37% 93.37%
=======================================
Files 240 240
Lines 3941 3941
Branches 138 141 +3
=======================================
Hits 3680 3680
Misses 261 261Continue to review full report at Codecov.
|
docs/src/main/tut/faq.md
Outdated
|
|
||
| Below is a list of symbols used in cats. | ||
|
|
||
| The `~>`, `⊥` and `⊤` symbols can be imported with `import cats._`. |
There was a problem hiding this comment.
:<: and :≺: was added to cats package in #1557
|
@zainab-ali do you plan to continue this one? |
|
Yes - I think I've got all the symbols, but can't find a definitive way of checking. Any ideas are welcome. |
|
Would nicknames be useful here? I've heard "scream" or "cinnabon" for |
|
I like the idea - especially as part of the FAQ. I think @fommil had some ideas on names earlier. |
|
nice! I'm going to print this out and keep it on my desk |
|
@rossabaker where / what is |
|
I might have just had a Perl flashback with There is a |
|
@zainab-ali got any time to continue this one, if not I'll be more than happy to take over. |
|
Sorry for taking so long on this one. I've added the cinnabon / scream nickname, but am having trouble thinking of others. |
|
@rossabaker , would you mind take another look? |
|
This is nice. The table works for me on GitHub if I escape the pipes in Only missing ones I can think of:
I thought we'd have more nicknames when I suggested it, but Cats doesn't have left fish ( |
|
Jekyll didn't like the backslashes for me. This post seems to do the trick, though it's somewhat of a mess. It works with both Jekyll and GitHub. |
| | `x === y` | equals | | `Eq[A]` | `eqv(x: A, y: A): Boolean` | | ||
| | `x =!= y` | not equals | | `Eq[A]` | `neqv(x: A, y: A): Boolean` | | ||
| | `fa >>= f` | flatMap | | `FlatMap[F[_]]` | `flatMap(fa: F[A])(f: A => F[B]): F[B]` | | ||
| | `fa >> fb` | followed by | | `FlatMap[F[_]]` | `followedBy(fa: F[A])(fb: F[B]): F[B]` | |
There was a problem hiding this comment.
As of #1537 there is also << (FlatMap#forEffect).
There was a problem hiding this comment.
I've now added that
|
Sorry for the late feedback. If you want to add |
|
I've added |
|
The build is failing with a python pip error - is this a transient issue? |
|
Is it perhaps worth it to include more fine-grained imports for the symbols than |
|
@edmundnoble I agree. This PR is already a big improvement from what we have. Shall we merge it for now and work on the fine-grained imports in another PR? |
|
SGTM @kailuowang. Let's get this in. |
Add symbols to FAQ, as discussed in #1384