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

Add Nomenclature / Cheatsheet page #2558

Merged
merged 2 commits into from
Nov 8, 2018
Merged

Add Nomenclature / Cheatsheet page #2558

merged 2 commits into from
Nov 8, 2018

Commits on Oct 17, 2018

  1. Documentation: add a nomenclature page.

    This commit introduces a new page to the documentation,
    showing the name and simplified type signatures of the methods
    in the type classes and data types of the cats library.
    
    Whereas other pages of the documentation try to explain one
    type-class at a time in a manner that is amenable to beginners;
    whereas the Scaladocs are good only for those who remember the
    name of the type-class and want to recall what they do.
    
    ScalaDocs, in particular, suffer from a limitation: they are
    structured following the classes-packages-objects structure
    of the Scala codeHowever, practitioners using a type-class
    or a data type may be interested on browsing easyily through
    different methods that may be defined in separate "modules".
    diesalbla committed Oct 17, 2018
    Configuration menu
    Copy the full SHA
    ebcc9b2 View commit details
    Browse the repository at this point in the history

Commits on Oct 18, 2018

  1. Improve the introduction.

    - Attend code review comments, and mention PartialFunction.
    - Add section on the Kleisli data structure.
    diesalbla committed Oct 18, 2018
    Configuration menu
    Copy the full SHA
    1251004 View commit details
    Browse the repository at this point in the history