-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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 tut doc for FunctionK #1604
Conversation
I'm sure that there is more that could be done with this, and I'm very open to recommendations, but I wanted to get something out there.
Codecov Report
@@ Coverage Diff @@
## master #1604 +/- ##
=======================================
Coverage 93.11% 93.11%
=======================================
Files 250 250
Lines 3992 3992
Branches 138 136 -2
=======================================
Hits 3717 3717
Misses 275 275 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the step by step concpets derivation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice! I am still uncomfortable with this "operates on kinds" malarkey, especially after discussion in #1358, but that should probably be removed en-masse if at all.
@edmundnoble thanks for drawing attention to the "operates on kinds" wording. I agree that it's at best sloppy. I'm trying to think of what a better alternate wording word be. The ScalaDoc for
While this is a more accurate description, I think that it's probably not going to be much help to many people who are looking at What do you think about something like:
|
Will the language here gives people the impression that it won't work for " |
@kailuowang I suppose that's a possibility. But I also am hesitant to try to shove much more information into that intro description. Maybe it would be better to provide an example with a type such as |
- Clean up sloppy usage of the term "kind" - Mention the `~>` type alias - Show example of fixing the left of `Either` to make it work with `FunctionK`.
@edmundnoble @kailuowang @peterneyens I've made some changes:
When you get a chance, please take another look and let me know what you think. |
We still need to add a menu link. |
@peterneyens good catch. I've added the menu link. |
LGTM 👍 |
I'm sure that there is more that could be done with this, and I'm very
open to recommendations, but I wanted to get something out there.