Topic/doc overhaul wip #1145
Topic/doc overhaul wip #1145
Conversation
Move build instructions to contributing guide
…ic/doc-overhaul-wip
|
|
||
| (We also plan to support [Miniboxing](http://scala-miniboxing.org) in a branch.) | ||
|
|
||
| Currently Cats is experimenting with providing laziness via a type |
There was a problem hiding this comment.
Missing space before This design may change
|
I really like the shorter readme. LGTM 👍 |
Current coverage is 88.80%@@ master #1145 diff @@
==========================================
Files 228 228
Lines 3028 3028
Methods 2980 2980
Messages 0 0
Branches 46 46
==========================================
Hits 2689 2689
Misses 339 339
Partials 0 0
|
|
👍 I think there's more work to do, but I think this is a step in the right direction. |
| Initially Cats will support the following modules: | ||
|
|
||
| * `macros`: Macro definitions needed for `core` and other projects. | ||
| * `core`: Definitions for widely-used type classes and data types. |
There was a problem hiding this comment.
how about taking the opportunity to add kernel and bench?
Cats consists of sub modules, both to keep the size of the
artifacts down and also to avoid unnecessarily tight coupling between
type classes and data types.
Cats supports the following modules:
* `core`: Definitions for widely-used type classes and data types.
* `bench`: Benchmarking suites. Not published.
* `free`: Free structures such as the free monad, and supporting type classes.
* `kernel`: Definitions for the basic algebraic type classes
* `kernel-laws`: The encoded laws for type classes defined in `kernel`, exported to assist third-party testing.
* `laws`: The encoded laws for type classes defined in `core`, exported to assist third-party testing.
* `macros`: Macro definitions needed for `core` and other projects.
* `tests`: Verifies the laws, and runs any other tests. Not published.
There was a problem hiding this comment.
@non are you planning on adding this? I'm happy to add it in a followup PR if that's easier for you.
|
I'm going to go ahead and merge this and we can follow up with further items in separate PRs. Thanks @non! |
As suggested in typelevel#1145 (comment)
|
@ceedubs I can create a PR on the design change. |
|
@kailuowang @non I created #1162 for the module changes in the design doc (sorry @kailuowang it was before your message, or at least before I saw it). |
This is a doc overhaul @ceedubs and I were working on.
I'm not 100% sure it's ready to go but I'm pushing this for early review. Suggestions, editions, and additions are all very welcome. /cc @ceedubs