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

Remove fine-grained imports from docs #2651

Closed
tpolecat opened this issue Nov 30, 2018 · 5 comments
Closed

Remove fine-grained imports from docs #2651

tpolecat opened this issue Nov 30, 2018 · 5 comments

Comments

@tpolecat
Copy link
Member

Some of the doc pages use fine-grained imports, which we should discourage as it's very tricky (so tricky in fact that most advanced users don't even try) and is a source of discouraging problems and many questions on the Gitter channel. Can we go through the doc and remove them?

@calvinbrown085
Copy link
Contributor

Hi @tpolecat do you have an example here? I'm guessing it's somewhere we can import ._ instead?

@LukaJCB
Copy link
Member

LukaJCB commented Dec 5, 2018

@calvinbrown085
In general when there's docs where anything apart from import cats.implicits._ is used, change it to cats.implicits._ instead. So e.g. in https://github.com/typelevel/cats/blob/master/docs/src/main/tut/typeclasses/applicative.md

you'll see this:

import cats.instances.list._
import cats.syntax.traverse._

That should be changed to just

import cats.implicits._

@calvinbrown085
Copy link
Contributor

@LukaJCB Ah, that makes sense! I can try to go through and find some of these to fix

@calvinbrown085
Copy link
Contributor

Is there anything else we need here? Or can we close this issue?

@ceedubs
Copy link
Contributor

ceedubs commented Dec 10, 2018

I think that this can be closed out now. Thanks, @calvinbrown085!

@ceedubs ceedubs closed this as completed Dec 10, 2018
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

4 participants