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

typeclass -> type class #1149

Merged
merged 1 commit into from Jun 19, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGES.md
Expand Up @@ -69,7 +69,7 @@ This release includes some API changes:

And additions:

* [#853](https://github.com/typelevel/cats/pull/853): Adds a new `LiftTrans` typeclass
* [#853](https://github.com/typelevel/cats/pull/853): Adds a new `LiftTrans` type class
* [#864](https://github.com/typelevel/cats/pull/864): Add `Bifoldable`
* [#875](https://github.com/typelevel/cats/pull/875): Add `.get` method to `StateT`
* [#884](https://github.com/typelevel/cats/pull/884): Add `Applicative` syntax
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/scala/cats/TransLift.scala
Expand Up @@ -2,13 +2,13 @@ package cats


/**
* A typeclass which abstracts over the ability to lift an M[A] into a
* A type class which abstracts over the ability to lift an M[A] into a
* MonadTransformer
*/
trait TransLift[MT[_[_], _]] {

/**
* The typeclass which constrains liftT as a function of the type
* The type class which constrains liftT as a function of the type
* constructor it is given. A safe "identity" value for this type
* if your transformer does not constrain its lifted effects would
* be `type TC[M[_]] = Trivial`. A more common constraint might be
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/scala/cats/Trivial.scala
@@ -1,11 +1,11 @@
package cats

/**
* The "Unit typeclass". The only instance of `Trivial` is given by
* The "Unit type class". The only instance of `Trivial` is given by
* `Trivial.manifest`, and this instance is guaranteed to be in the
* implicit scope. Several convenience type aliases are provided in
* companion object, covering a few common use cases and avoiding the
* need for unnecessary lambdas (e.g. if you want a trivial typeclass
* need for unnecessary lambdas (e.g. if you want a trivial type class
* instance for a type constructor, you should use `Trivial.PH1`).
*/
sealed trait Trivial
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/contravariant.md
Expand Up @@ -51,7 +51,7 @@ Salary(Money(1000)).show

`Show` example is trivial and quite far-fetched, let's see how `Contravariant` can help with orderings.

`scala.math.Ordering` typeclass defines comparison operations, e.g. `compare`:
`scala.math.Ordering` type class defines comparison operations, e.g. `compare`:

```tut:book
Ordering.Int.compare(2, 1)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/faq.md
Expand Up @@ -15,7 +15,7 @@ import cats.data._
import cats.implicits._
```

The `cats._` import brings in quite a few [typeclasses](http://typelevel.org/cats/typeclasses.html) (similar to interfaces) such as [Monad](http://typelevel.org/cats/tut/monad.html), [Semigroup](http://typelevel.org/cats/tut/semigroup.html), and [Foldable](http://typelevel.org/cats/tut/foldable.html). Instead of the entire `cats` package, you can import only the types that you need, for example:
The `cats._` import brings in quite a few [type classes](http://typelevel.org/cats/typeclasses.html) (similar to interfaces) such as [Monad](http://typelevel.org/cats/tut/monad.html), [Semigroup](http://typelevel.org/cats/tut/semigroup.html), and [Foldable](http://typelevel.org/cats/tut/foldable.html). Instead of the entire `cats` package, you can import only the types that you need, for example:

```tut:silent
import cats.Monad
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/invariant.md
Expand Up @@ -30,7 +30,7 @@ timestamp. Let's say that we want to create a `Semigroup[Date]`, by
### Semigroup does not form a covariant functor

If `Semigroup` had an instance for the standard covariant [`Functor`](functor.html)
typeclass, we could use `map` to apply a function `longToDate`:
type class, we could use `map` to apply a function `longToDate`:

```tut:silent
import java.util.Date
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/tut/symbols.md
Expand Up @@ -8,7 +8,7 @@ All other symbols can be imported with `import cats.implicits._`

A scaladoc generated list is also available on the [Scaladoc symbols page](http://typelevel.org/cats/api/#index.index-_).

| Symbol | Name | Typeclass | Definition |
| Symbol | Name | Type Class | Definition |
| ---------- | ---------------------- | ---------------------------------------------------------------------------------------- |--------------------------------------- |
| `fa |@| fb`| Cartesian builder | [`Cartesian[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/Cartesian.scala) | `|@|(fa: F[A])(fb: F[B]): F[(A, B)]` |
| `fa *> fb` | right apply | [`Cartesian[F[_]]`]({{ site.sources }}/core/src/main/scala/cats/Cartesian.scala) | `*>(fa: F[A])(fb: F[B]): F[A]` |
Expand All @@ -28,4 +28,4 @@ A scaladoc generated list is also available on the [Scaladoc symbols page](http:
| `F :<: G` | inject | [`Inject[F[_], G[_]]`]({{ site.sources }}/free/src/main/scala/cats/free/package.scala) | `Inject` alias |
| `F :≺: G` | inject | [`Inject[F[_], G[_]]`]({{ site.sources }}/free/src/main/scala/cats/free/package.scala) | `Inject` alias |
| `⊥` | bottom | [N/A]({{ site.sources }}/core/src/main/scala/cats/package.scala) | `Nothing` |
| `⊤` | top | [N/A]({{ site.sources }}/core/src/main/scala/cats/package.scala) | `Any` |
| `⊤` | top | [N/A]({{ site.sources }}/core/src/main/scala/cats/package.scala) | `Any` |
2 changes: 1 addition & 1 deletion docs/src/site/_layouts/default.html
Expand Up @@ -41,7 +41,7 @@ <h1>Cats</h1>
<a href="{{ site.baseurl }}/index.html">About</a>
</li>
<li {%if page.section =="typeclasses" %} class="active" {% else %} class="inactive" {% endif%}>
<a href="{{ site.baseurl }}/typeclasses.html">Typeclasses</a>
<a href="{{ site.baseurl }}/typeclasses.html">Type Classes</a>
</li>
<li {%if page.section =="data" %} class="active" {% else %} class="inactive" {% endif %}>
<a href="{{ site.baseurl }}/datatypes.html">Data Types</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/site/typeclasses.md
@@ -1,6 +1,6 @@
---
layout: default
title: "Typeclasses"
title: "Type Classes"
section: "typeclasses"
---
{% include_relative _tut/typeclasses.md %}
Expand Down