finagle/finch

Scaladoc hygiene for base package

Open

#411 opened on Oct 12, 2015

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)Scala (218 forks)batch import
cleanupeasyhelp wanted

Repository metrics

Stars
 (1,594 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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).

Contributor guide

Research direction
Identify prioritization traits in the base package and modify their visibility to private[finch] so they are excluded from Scaladoc. Then explore using Scaladoc groups to organize definitions, similar to examples in the circe library.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaScaladoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70