akka/akka-core

Paradox directive that can create Java signatures for the documentation

Ouverte

#24 931 ouverte le 19 avr. 2018

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Scala (3 547 forks)batch import
1 - triagedhelp wantedt:docs

Métriques du dépôt

Stars
 (13 277 étoiles)
Métriques de merge PR
 (Merge moyen 8j 19h) (10 PRs mergées en 30 j)

Description

Because our javadsl is written in Scala this would need some processing to make it suitable for the Java version of the docs.

Guide contributeur

Direction de recherche
Commencez par examiner les directives Paradox existantes dans le dépôt akka core, en particulier celles liées à la documentation. Comprenez comment javadsl est structuré et comment il correspond au code Java. Recherchez toute discussion antérieure ou issue liée concernant la génération de signatures Java. Réfléchissez à la manière dont le code Scala peut être transformé pour produire des signatures d'API adaptées à Java pour la documentation.
Stack technique
scalajava
Domaine
documentation
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.
1-3 heures
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.
Plutôt claire
Prérequis
ScalaParadox
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60