finagle/finch

Scaladoc hygiene for base package

Open

#411 opened on Oct 12, 2015

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Scala (1,597 stars) (221 forks)batch import
cleanupeasyhelp wanted

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

Tech stack
scala
Domain
documentationbackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalaScaladocFinch library basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the reference implementation in circe (linked in issue) to understand Scaladoc group usage. Then locate the source files under the io.finch package in the Finch repository, identify traits that should be made private[finch], and apply the private modifier and group annotations accordingly. Review existing Scaladoc comments to ensure consistency.
Scaladoc hygiene for base package · finagle/finch#411 | Good First Issue