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

document imports #912

Closed
stew opened this issue Mar 3, 2016 · 5 comments
Closed

document imports #912

stew opened this issue Mar 3, 2016 · 5 comments

Comments

@stew
Copy link
Contributor

stew commented Mar 3, 2016

We need a document which states exactly what needs to be import when, so that newcomers know exactly what imports do what, and what the basic set is they can use to get going.

@longcao
Copy link
Contributor

longcao commented Mar 4, 2016

For posterity: @non mentioned in the round table discussion at the Typelevel Summit unconference that it should be the standard to publish only:

import cats.implicits._

as the fully-capable gateway to using cats, and that more specific imports can be used but with the caveat of being a) not exhaustively documented and b) for more advanced usage. IMO, part of this would include rewriting current tut documentation to use only import cats.implicits._, and publishing that this is the recommended pathway.

(hope I remembered correctly!)

@lvicentesanchez
Copy link

+1 for using import cats.implicits._ in the documentation, but I would love to have an advanced usage section with an extended version of what @noelmarkham has started here.

@longcao
Copy link
Contributor

longcao commented Mar 16, 2016

@lvicentesanchez 👍 that's pretty nice! I think that cheat sheet might be good to have in the documentation, perhaps as a sub-bullet to core in "Project Structure" (http://typelevel.org/cats/)

noelmarkham added a commit to noelmarkham/cats that referenced this issue Mar 16, 2016
Placement suggested in typelevel#912
@noelmarkham
Copy link

I've started a PR at #936

@ceedubs ceedubs mentioned this issue May 14, 2016
8 tasks
ceedubs added a commit to ceedubs/cats that referenced this issue Jun 7, 2016
This is just a start, and there are some more items that we will
probably want to add.

The import section probably is really a start to typelevel#912, and may end up
simply referencing a separate import document, as discussed in typelevel#936. But
I thought it would be nice to get something out there as an interim
resolution.
@ceedubs
Copy link
Contributor

ceedubs commented May 13, 2017

There has been an imports guide for a while. One thing that it doesn't include is a guide on piecemeal imports, so I've created #1668 to track that.

@ceedubs ceedubs closed this as completed May 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants