protocolbuffers/protobuf

support documentation in code generated bindings

Open

#985 opened on Nov 18, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (16,128 forks)batch import
P3enhancementhelp wanted

Repository metrics

Stars
 (71,223 stars)
PR merge metrics
 (Avg merge 2d 11h) (185 merged PRs in 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.

Contributor guide

Research direction
Look at how Java generates documentation in protobuf code. Then examine the C++ and Python code generators to add similar documentation copying.
Tech stack
pythonjava
Domain
backendapidocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitProtocol BuffersCode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65