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

Avoid kind-projector in docs where possible #1033

Closed
ceedubs opened this issue May 14, 2016 · 3 comments
Closed

Avoid kind-projector in docs where possible #1033

ceedubs opened this issue May 14, 2016 · 3 comments

Comments

@ceedubs
Copy link
Contributor

ceedubs commented May 14, 2016

The kind-projector usage in the docs trips up a lot of people (as evident by it frequently coming up in Gitter questions). I think that where possible we should use simple type aliases instead of kind-projector syntax.

If we have any cases where a simple type alias isn't possible, I like using kind-projector instead of a type lambda, but I think that we should preface the first such usage on each page with an explanation that kind-projector is being used.

@ceedubs ceedubs changed the title Avoid kind-project in docs where possible Avoid kind-projector in docs where possible May 14, 2016
@ceedubs ceedubs mentioned this issue May 14, 2016
8 tasks
@peterneyens
Copy link
Collaborator

peterneyens commented May 15, 2016

In the Functor documentation there already is an explanation about the kind projector plugin.

Do you suggest writing something similar on the other pages where kind projector usage can't be replaced by a type alias, or should we create a new page about kind projector where we could link to ?

@ceedubs
Copy link
Contributor Author

ceedubs commented May 16, 2016

@peterneyens I guess it would depend on how many can't be replaced by a simple type alias. If it's only one then inline is probably fine, but otherwise we should probably create a new page. Either way having a new page that we link to probably wouldn't be a bad thing.

@ceedubs
Copy link
Contributor Author

ceedubs commented May 17, 2016

I'm working on this.

@ceedubs ceedubs self-assigned this May 17, 2016
ceedubs added a commit to ceedubs/cats that referenced this issue May 17, 2016
Resolves typelevel#1033 although in all but one place, a simple type alias was
not possible.
@stew stew removed the in progress label May 18, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants