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.

Sign up for GitHub

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

Jump to bottom

Update README and other documents for 0.4.0 #851

Merged
merged 2 commits into from
Feb 1, 2016
Merged

Update README and other documents for 0.4.0 #851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c40419
Update README and other root docs for 0.4.0
travisbrown Feb 1, 2016
dcb4c8a
Update version in site for 0.4.0
travisbrown Feb 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,94 +255,94 @@ Version 0.3.0 is the third release of the Cats library.

This version includes new type class instances:

* [#545](https://github.com/non/cats/pull/545): `Semigroup` instances for
* [#545](https://github.com/typelevel/cats/pull/545): `Semigroup` instances for
`OneAnd`
* [#521](https://github.com/non/cats/pull/521): `Monoid` instances for `Xor`
* [#521](https://github.com/typelevel/cats/pull/521): `Monoid` instances for `Xor`
when the left side has a `Semigroup` instance and the right side has a
`Monoid`
* [#497](https://github.com/non/cats/pull/497): `Monoid` instances for `Set`
* [#559](https://github.com/non/cats/pull/559): `Bifunctor` instances for
* [#497](https://github.com/typelevel/cats/pull/497): `Monoid` instances for `Set`
* [#559](https://github.com/typelevel/cats/pull/559): `Bifunctor` instances for
`Validated`, `Ior`, `Xor`, and `XorT`
* [#569](https://github.com/non/cats/pull/569): `Functor` instances for
* [#569](https://github.com/typelevel/cats/pull/569): `Functor` instances for
`OptionT` when `F` has a `Functor` instance but not a `Monad`
* [#600](https://github.com/non/cats/pull/600): `Show` instances for `Option`
* [#600](https://github.com/typelevel/cats/pull/600): `Show` instances for `Option`
and `OptionT`
* [#601](https://github.com/non/cats/pull/601): `Show` instances for `List`
* [#602](https://github.com/non/cats/pull/602): `Show` instances for `Set`
* [#568](https://github.com/non/cats/pull/568): Several new `Unapply` shapes
* [#601](https://github.com/typelevel/cats/pull/601): `Show` instances for `List`
* [#602](https://github.com/typelevel/cats/pull/602): `Show` instances for `Set`
* [#568](https://github.com/typelevel/cats/pull/568): Several new `Unapply` shapes

And API changes:

* [#592](https://github.com/non/cats/pull/592): `fromTryCatch` on `Xor` and
* [#592](https://github.com/typelevel/cats/pull/592): `fromTryCatch` on `Xor` and
`Validated` is now `catchOnly`
* [#553](https://github.com/non/cats/pull/553): `MonadError` now characterizes
* [#553](https://github.com/typelevel/cats/pull/553): `MonadError` now characterizes
type constructors of kind `* -> *` instead of `(*, *) -> *`
* [#598](https://github.com/non/cats/pull/598): `OneAnd`'s type constructor type
* [#598](https://github.com/typelevel/cats/pull/598): `OneAnd`'s type constructor type
parameter is now before the element type
* [#610](https://github.com/non/cats/pull/610): `XorT`'s `toOption` returns an
* [#610](https://github.com/typelevel/cats/pull/610): `XorT`'s `toOption` returns an
`OptionT[F, B]` instead of an `F[Option[B]]`
* [#518](https://github.com/non/cats/pull/518): `Free`'s `resume` method now
* [#518](https://github.com/typelevel/cats/pull/518): `Free`'s `resume` method now
returns an `Xor` instead of an `Either`
* [#575](https://github.com/non/cats/pull/575) and
[#606](https://github.com/non/cats/pull/606): `orElse` on `Xor` and
* [#575](https://github.com/typelevel/cats/pull/575) and
[#606](https://github.com/typelevel/cats/pull/606): `orElse` on `Xor` and
`Validated` does not unnecessarily constrain the type of the left side of the
result
* [#577](https://github.com/non/cats/pull/577): `*Aux` helper classes have been
* [#577](https://github.com/typelevel/cats/pull/577): `*Aux` helper classes have been
renamed `*PartiallyApplied`

And additions:

* [#542](https://github.com/non/cats/pull/542): `WriterT`
* [#567](https://github.com/non/cats/pull/567): `Ior.fromOptions`
* [#528](https://github.com/non/cats/pull/528): `OptionT.fromOption`
* [#562](https://github.com/non/cats/pull/562): `handleErrorWith` and related
* [#542](https://github.com/typelevel/cats/pull/542): `WriterT`
* [#567](https://github.com/typelevel/cats/pull/567): `Ior.fromOptions`
* [#528](https://github.com/typelevel/cats/pull/528): `OptionT.fromOption`
* [#562](https://github.com/typelevel/cats/pull/562): `handleErrorWith` and related
helper methods on `MonadError`
* [#520](https://github.com/non/cats/pull/520): `toNel` and `fromList`
* [#520](https://github.com/typelevel/cats/pull/520): `toNel` and `fromList`
conversions from `List` to `NonEmptyList`
* [#533](https://github.com/non/cats/pull/533): Conversions between types with
* [#533](https://github.com/typelevel/cats/pull/533): Conversions between types with
`Foldable` instances and `Streaming`
* [#507](https://github.com/non/cats/pull/507): `isJvm` and `isJs` macros in the
* [#507](https://github.com/typelevel/cats/pull/507): `isJvm` and `isJs` macros in the
new `cats.macros.Platform`
* [#572](https://github.com/non/cats/pull/572): `analyze` on `FreeApplicative`
* [#572](https://github.com/typelevel/cats/pull/572): `analyze` on `FreeApplicative`
for compilation into a `Monoid`
* [#587](https://github.com/non/cats/pull/587): Syntax for lifting values (and
* [#587](https://github.com/typelevel/cats/pull/587): Syntax for lifting values (and
optional values) into `Validated`

And several aliases:

* [#492](https://github.com/non/cats/pull/492): `FlatMapSyntax` now includes
* [#492](https://github.com/typelevel/cats/pull/492): `FlatMapSyntax` now includes
`followedBy`, which is an alias for `>>`, together with a new
`followedByEval`, which allows the caller to choose the evaluation strategy of
the second action
* [#523](https://github.com/non/cats/pull/523): `Foldable` now has a
* [#523](https://github.com/typelevel/cats/pull/523): `Foldable` now has a
`combineAll` method that aliases `fold` and allows postfix usage via
`FoldableSyntax`

And a few removals:

* [#524](https://github.com/non/cats/pull/524): `FreeApplicative`'s redundant
* [#524](https://github.com/typelevel/cats/pull/524): `FreeApplicative`'s redundant
`hoist`, which was equivalent to `compile`
* [#531](https://github.com/non/cats/pull/531): `Coyoneda`'s `by`
* [#612](https://github.com/non/cats/pull/612): Many prioritization and instance
* [#531](https://github.com/typelevel/cats/pull/531): `Coyoneda`'s `by`
* [#612](https://github.com/typelevel/cats/pull/612): Many prioritization and instance
traits are now private

And bug fixes:

* [#547](https://github.com/non/cats/pull/547): The `empty` values for
* [#547](https://github.com/typelevel/cats/pull/547): The `empty` values for
`Monoid[Double]` and `Monoid[Float]` are now `0` instead of `1`
* [#530](https://github.com/non/cats/pull/530): `Streaming.take(n).toList` no
* [#530](https://github.com/typelevel/cats/pull/530): `Streaming.take(n).toList` no
longer evaluates the `n + 1`-st element
* [#538](https://github.com/non/cats/pull/538): `OneAnd`'s instances are
* [#538](https://github.com/typelevel/cats/pull/538): `OneAnd`'s instances are
properly prioritized

There are also many improvements to the documentation, tutorials, laws, tests,
and benchmarks:

* [#522](https://github.com/non/cats/pull/522): ScalaTest's `===` now uses `Eq`
* [#522](https://github.com/typelevel/cats/pull/522): ScalaTest's `===` now uses `Eq`
instances
* [#502](https://github.com/non/cats/pull/502): `Traverse`'s laws verify the
* [#502](https://github.com/typelevel/cats/pull/502): `Traverse`'s laws verify the
consistency of `foldMap` and `traverse`
* [#519](https://github.com/non/cats/pull/519): Benchmarks (and performance
* [#519](https://github.com/typelevel/cats/pull/519): Benchmarks (and performance
improvements) for `Eval`
* …and many others

Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ section: "contributing"
# Contributor guide

Discussion around Cats is currently happening in the
[Gitter channel](https://gitter.im/non/cats) as well as on Github
[Gitter channel](https://gitter.im/typelevel/cats) as well as on Github
issue and PR pages. You can get an overview of who is working on what
via [Waffle.io](https://waffle.io/non/cats).
via [Waffle.io](https://waffle.io/typelevel/cats).

Feel free to open an issue if you notice a bug, have an idea for a
feature, or have a question about the code. Pull requests are also
Expand Down Expand Up @@ -54,7 +54,7 @@ skip these steps and jump straight to submitting a pull request.
### Find something that belongs in cats

Looking for a way that you can help out? Check out our
[Waffle.io page](https://waffle.io/non/cats). Choose a card from the
[Waffle.io page](https://waffle.io/typelevel/cats). Choose a card from the
"Ready" column. Before you start working on it, make sure that it's
not already assigned to someone and that nobody has left a comment
saying that they are working on it!
Expand All @@ -66,9 +66,9 @@ Have an idea for something new? That's great! We recommend that you
make sure it belongs in cats before you put effort into creating a
pull request. The preferred ways to do that are to either:

* [create a GitHub issue](https://github.com/non/cats/issues/new)
* [create a GitHub issue](https://github.com/typelevel/cats/issues/new)
describing your idea.
* get feedback in the [cats Gitter room](https://gitter.im/non/cats).
* get feedback in the [cats Gitter room](https://gitter.im/typelevel/cats).

Things that belong in cats generally have the following characteristics:

Expand Down Expand Up @@ -106,11 +106,11 @@ TODO

*Should this just link to a separate doc? This might get large.*

Write about implicit params as discussed in https://github.com/non/cats/issues/27
Write about implicit params as discussed in https://github.com/typelevel/cats/issues/27

Write about type class methods on data structures as described in https://github.com/non/cats/issues/25
Write about type class methods on data structures as described in https://github.com/typelevel/cats/issues/25

Write about https://github.com/non/cats/pull/36#issuecomment-72892359
Write about https://github.com/typelevel/cats/pull/36#issuecomment-72892359

### Write tests

Expand Down Expand Up @@ -143,7 +143,7 @@ Write about checking laws
## Contributing documentation

### source for the documentation
The documentation for this website is stored alongside the source, in the [docs subproject](https://github.com/non/cats/tree/master/docs).
The documentation for this website is stored alongside the source, in the [docs subproject](https://github.com/typelevel/cats/tree/master/docs).

* The source for the static pages is in `docs/src/site`
* The source for the tut compiled pages is in `docs/src/main/tut`
Expand Down Expand Up @@ -211,7 +211,7 @@ the contribution process for the cats project.
It may take a while to familiarize yourself with this document, but if
we are doing our job right, you shouldn't have to spend months poring
over the project source code or lurking the
[Gitter room](https://gitter.im/non/cats) before you feel comfortable
[Gitter room](https://gitter.im/typelevel/cats) before you feel comfortable
contributing. In fact, if you encounter any confusion or frustration
during the contribution process, please create a GitHub issue and
we'll do our best to improve the process.
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Workflow](https://badge.waffle.io/typelevel/cats.svg?label=ready&title=Ready)](https://waffle.io/typelevel/cats)
[![Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/typelevel/cats)
[![codecov.io](http://codecov.io/github/typelevel/cats/coverage.svg?branch=master)](http://codecov.io/github/typelevel/cats?branch=master)
[![Maven Central](https://img.shields.io/maven-central/v/org.spire-math/cats_2.11.svg)](https://maven-badges.herokuapp.com/maven-central/org.spire-math/cats_2.11)
[![Maven Central](https://img.shields.io/maven-central/v/org.typelevel/cats_2.11.svg)](https://maven-badges.herokuapp.com/maven-central/org.typelevel/cats_2.11)

### Overview

Expand All @@ -23,7 +23,7 @@ To get started with SBT, simply add the following to your `build.sbt`
file:

```scala
libraryDependencies += "org.spire-math" %% "cats" % "0.3.0"
libraryDependencies += "org.typelevel" %% "cats" % "0.4.0"
```

This will pull in all of Cats' modules. If you only require some
Expand All @@ -36,7 +36,7 @@ functionality, you can pick-and-choose from amongst these modules

Release notes for Cats are available in [CHANGES.md](CHANGES.md).

*Cats 0.3.0 is a pre-release: there are not currently source- or
*Cats 0.4.0 is a pre-release: there are not currently source- or
binary-compatibility guarantees.*

### Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/src/site/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Cats is currently available for Scala 2.10 and 2.11.

To get started with SBT, simply add the following to your build.sbt file:

libraryDependencies += "org.spire-math" %% "cats" % "0.3.0"
libraryDependencies += "org.typelevel" %% "cats" % "0.4.0"

This will pull in all of Cats' modules. If you only require some
functionality, you can pick-and-choose from amongst these modules
Expand Down