finagle/finch

Scaladoc hygiene for base package

Offen

#411 geöffnet am 12.10.2015

Auf GitHub ansehenContributor Guide
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Scala (218 Forks)batch import
cleanupeasyhelp wanted

Repository-Metriken

Stars
 (1.594 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Identifiziere die Priorisierungs Traits im Basispaket und ändere ihre Sichtbarkeit auf private[finch], damit sie aus Scaladoc ausgeschlossen werden. Erkunde dann die Verwendung von Scaladoc Gruppen zur Organisation von Definitionen, ähnlich wie in der circe Bibliothek.
Tech Stack
scala
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
ScalaScaladoc
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70