finagle/finch

Scaladoc hygiene for base package

Ouverte

#411 ouverte le 12 oct. 2015

Voir sur GitHubGuide contributeur
 (6 commentaires) (0 réaction) (0 personne assignée)Scala (218 forks)batch import
cleanupeasyhelp wanted

Métriques du dépôt

Stars
 (1 594 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Identifiez les traits de priorisation dans le package de base et modifiez leur visibilité en private[finch] pour qu'ils soient exclus de Scaladoc. Explorez ensuite l'utilisation des groupes Scaladoc pour organiser les définitions, comme dans les exemples de la bibliothèque circe.
Stack technique
scala
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
ScalaScaladoc
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70