search

finagle / finch

Scala combinator library for building Finagle HTTP services
https://finagle.github.io/finch
Apache License 2.0
1.6k stars 221 forks source link

Scaladoc hygiene for base package #411

Open travisbrown opened 9 years ago

travisbrown commented 9 years ago

As more stuff gets moved directly under io.finch, its API docs are getting a little unwieldy. It'd be nice to make prioritization traits private[finch] so they don't show up in the docs (their methods still will, though), and possibly even to organize the definitions using Scaladoc groups (see e.g. how I'm using them in circe).

vkostyukov commented 9 years ago

Great idea!

lukewyman commented 8 years ago

I'd like to take this one.

vkostyukov commented 8 years ago

This is great @lukewyman! Let us know if you need any help with that.

lukewyman commented 8 years ago

Thanks, @vkostyukov. I've been picking through the code and I can't quite find a case of (or might not understand completely) a prioritaztion trait. Can you possibly provide me with a place in the code as an example so that I can pick up the pattern? @travisbrown

lukewyman commented 8 years ago

Perhaps io.finch.internal.Mapper is an example? object Mapper would be the public level, and then the traits lower in the chain in that file (HighPriorityMapperConversions and LowPriorityMapperConversions) would get the private[finch] ?

vkostyukov commented 8 years ago

I'm going to move that to the next milestone so we can revisit that later and see what's left here.