finagle/finch

Scaladoc hygiene for base package

Open

#411 opened on 2015年10月12日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)Scala (1,597 stars) (221 forks)batch import
cleanupeasyhelp wanted

説明

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

コントリビューターガイド

技術スタック
scala
領域
documentationbackend
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
ScalaScaladocFinch library basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
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