protocolbuffers/protobuf

support documentation in code generated bindings

Open

#985 ouverte le 18 nov. 2015

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)C++ (16 128 forks)batch import
P3enhancementhelp wanted

Métriques du dépôt

Stars
 (71 223 stars)
Métriques de merge PR
 (Merge moyen 2j 11h) (185 PRs mergées en 30 j)

Description

A nice to have feature would be to copy over documentation present on the protobuf files into the code generated files for cpp, python. I believe it works for java currently.

Guide contributeur

Direction de recherche
Regardez comment Java genere la documentation dans le code protobuf. Ensuite, examinez les generateurs de code C++ et Python pour ajouter une copie similaire de la documentation.
Stack technique
pythonjava
Domaine
backendapidocumentation
Type d'issue
Fonctionnalité
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
GitProtocol BuffersCode generation concepts
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65