Adding documentation and tests for the ColumnTypes type class. #144
Conversation
|
Hey @kanterov this is a pretty benign change. Adds a bit more documentation and tests. Let me know if you have any comments. thanks! |
| implicit tail: ColumnTypes.Aux[V, TT, T] | ||
| ): ColumnTypes.Aux[V, TypedColumn[V, H] :: TT, H :: T] = | ||
| new ColumnTypes[V, TypedColumn[V, H] :: TT] {type Out = H :: T} | ||
| implicit def deriveCons[T, Head, Tail <: HList, ColTypes <: HList]( |
There was a problem hiding this comment.
What is the reasoning behind renaming? It falls off current coding style, as well as other OSS projects using shapeless
There was a problem hiding this comment.
Hey @kanterov, you mean about the head and tail? Yeah, that one I guess makes sense to use the standard H and TT. Overall the main goal of the rename was to make it a bit easier to understand the code. Maybe we can revert the Head/Tail back to their standard notations and leave the ColTypes as is (since it has a well defined semantic in our case)?
| * type Out = A :: B :: C :: HNil | ||
| * }}} | ||
| */ | ||
| trait ColumnTypes[T, U <: HList] { |
There was a problem hiding this comment.
This is mostly a workaround to issue with slow implicit derivation for Comapped
There was a problem hiding this comment.
Oh, just realized that this is a special case of using Comapped! Ok, I think I will add this comment in case someone in the future decide to revert this back to Comapped.
Codecov Report
@@ Coverage Diff @@
## master #144 +/- ##
=======================================
Coverage 93.68% 93.68%
=======================================
Files 28 28
Lines 649 649
Branches 11 11
=======================================
Hits 608 608
Misses 41 41
Continue to review full report at Codecov.
|
|
@kanterov I just unified the notation for ColumnsTypes and AggregateType (they were similar implementations but used different letters for their equivalent parameters). I reverted the notation back to the standard ones used by shapeless (as you suggested). Added some comments as well. Let me know if there is anything else. I will squash the three commits into one after you give a thumps up. |
|
@kanterov hello! anything else to improve here? |
imarios
force-pushed
the
documentation_and_tests_on_columntypes
branch
from
ab341da
to
35959b8
Compare
No description provided.