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

Some attribution work #1276

Merged
merged 5 commits into from
Aug 10, 2016
Merged

Some attribution work #1276

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
853c37f
Some attribution work
ceedubs Aug 9, 2016
8003ae4
Capitalize Scalaz in references
ceedubs Aug 9, 2016
efed110
Attribute Brian McKenna on `catchOnly` methods
ceedubs Aug 9, 2016
07866e4
Fix minor ScalaDoc typo
ceedubs Aug 9, 2016
4117f4e
Add Haskell Prelude to AUTHORS.md attributions
ceedubs Aug 9, 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
7 changes: 7 additions & 0 deletions AUTHORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ possible:
* Binh Nguyen
* Bobby Rauchenberg
* Brendan McAdams
* Brian McKenna
* Cody Allen
* Colt Frederickson
* Dale Wijnand
Expand Down Expand Up @@ -98,6 +99,12 @@ possible:
* yilinwei
* Zach Abbott

Cats has been heavily inspired by [scalaz](https://github.com/scalaz/scalaz),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:

Cats has been inspired by many libraries, including Scalaz, Haskell's Prelude, and others. In particular, some Cats code is only…

To acknowledge stuff like witherable, etc.?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 sorry I missed this when you first posted it.

and some Cats code is only a slightly modified version of code originating in
scalaz. Therefore, we'd also like to credit and thank all of the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nitpicky, but maybe capitalize "scalaz" throughout for consistency with "Cats" and other project names here, and with the Scalaz README?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thanks good catch. I tend to capitalize Cats to make it clear that I'm talking about the project and not the group of animals, but I definitely didn't mean to be inconsistent here.

[scalaz contributors](https://github.com/scalaz/scalaz/graphs/contributors) for
their work.

We've tried to include everyone, but if you've made a contribution to
Cats and are not listed, please feel free to open an issue or pull
request with your name and contribution.
Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,12 @@ Write about type class methods on data structures as described in https://github

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

### Attributions

If your contribution has been derived from or inspired by other work, please
state this in its ScalaDoc comment and provide proper attribution. When
possible, include the original authors' names and a link to the original work.

### Write tests

- Tests for cats-core go into the tests module, under the `cats.tests` package.
Expand Down
4 changes: 4 additions & 0 deletions core/src/main/scala/cats/FlatMapRec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ import cats.data.Xor
*
* Based on Phil Freeman's
* [[http://functorial.com/stack-safety-for-free/index.pdf Stack Safety for Free]].
*
* This Scala implementation of `FlatMapRec` and its usages are derived from
* [[https://github.com/scalaz/scalaz/blob/series/7.3.x/core/src/main/scala/scalaz/BindRec.scala scalaz's BindRec]],
* originally written by Brian McKenna.
*/
@typeclass trait FlatMapRec[F[_]] extends FlatMap[F] {

Expand Down
4 changes: 4 additions & 0 deletions core/src/main/scala/cats/NotNull.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ package cats
*
* This can be useful in preventing `Null` from being inferred when a type
* parameter is omitted.
*
* `NotNull`, its implementation, and its usages are derived from
* [[https://github.com/scalaz/scalaz/blob/series/7.3.x/core/src/main/scala/scalaz/NotNothing.scala scalaz's NotNothing]],
* originally written by Brian McKenna.
*/
sealed trait NotNull[A]

Expand Down