protocolbuffers/protobuf

support documentation in code generated bindings

Open

#985 aberto em 18 de nov. de 2015

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (16.128 forks)batch import
P3enhancementhelp wanted

Métricas do repositório

Stars
 (71.223 stars)
Métricas de merge de PR
 (Mesclagem média 2d 11h) (185 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Veja como o Java gera documentação no código protobuf. Em seguida, examine os geradores de código C++ e Python para adicionar cópia semelhante de documentação.
Pilha de tecnologia
pythonjava
Domain
backendapidocumentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GitProtocol BuffersCode generation concepts
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65