Skip to content

Commit

Permalink
Document caseClassDebug macros
Browse files Browse the repository at this point in the history
  • Loading branch information
japgolly committed Aug 14, 2015
1 parent acacaba commit f81e682
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions extra/PERF.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ and Scalaz classes `\/` and `\&/`. For all other types, you'll need to teach it
* `Reusability.by_==[A]` uses universal equality (ie. `a == b`)
* `Reusability.byEqual[A]` uses a Scalaz `Equal` typeclass
* `Reusability.caseClass[A]` for case classes of your own.
* `Reusability.caseClassDebug[A]` as above, but shows you the code that the macro generates.
* `Reusability.by(A => B)` to use a subset (`B`) of the subject data (`A`).
* `Reusability.fn((A, B) => Boolean)` to hand-write custom logic.

Expand Down
3 changes: 2 additions & 1 deletion extra/ROUTER2.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,8 @@ and is automatically converted to a finalised `Route` when used.
* `.filter(A => Boolean)` causes the route to ignore parsed values which don't satisfy the given filter.
* `.option` makes this subject portion of the route optional and turns a `RouteB[A]` into a `RouteB[Option[A]]`. Forms an isomorphism between `None` and an empty path.
* `.xmap[B](A => B)(B => A)` allows you to map the route type from an `A` to a `B`.
* `.caseClass[A]` maps the route type to a case class.
* `.caseClass[A]` maps the route type(s) to a case class.
* `.caseClassDebug[A]` as above, but shows you the code that the macro generates.

* Combinators on `RouteB[Option[A]]`
* `.withDefault(A)` - Specify a default value. Returns a `RouteB[A]`. Uses `==` to compare `A`s to the given default.
Expand Down

0 comments on commit f81e682

Please sign in to comment.