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

Scaladoc hygiene for base package #411

Open
travisbrown opened this issue Oct 12, 2015 · 6 comments
Open

Scaladoc hygiene for base package #411

travisbrown opened this issue Oct 12, 2015 · 6 comments

Comments

@travisbrown
Copy link
Member

@travisbrown travisbrown commented Oct 12, 2015

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 vkostyukov added this to the Finch 0.9.0 milestone Oct 12, 2015
@vkostyukov
Copy link
Member

@vkostyukov vkostyukov commented Oct 12, 2015

Great idea!

@vkostyukov vkostyukov modified the milestones: Finch 0.9.3, Finch 1.0.0 Dec 6, 2015
@lukewyman
Copy link
Contributor

@lukewyman lukewyman commented Feb 18, 2016

I'd like to take this one.

@vkostyukov
Copy link
Member

@vkostyukov vkostyukov commented Feb 19, 2016

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

@vkostyukov vkostyukov modified the milestones: Finch 0.11, Finch 1.0 Feb 19, 2016
@lukewyman
Copy link
Contributor

@lukewyman lukewyman commented Feb 19, 2016

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
Copy link
Contributor

@lukewyman lukewyman commented Feb 19, 2016

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
Copy link
Member

@vkostyukov vkostyukov commented Feb 29, 2016

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

@vkostyukov vkostyukov modified the milestones: Finch 1.0, Finch 0.11 Feb 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.