protocolbuffers/protobuf

support documentation in code generated bindings

Open

#985 opened on 2015年11月18日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)C++ (16,128 forks)batch import
P3enhancementhelp wanted

Repository metrics

Stars
 (71,223 stars)
PR merge metrics
 (平均マージ 2d 11h) (30d で 185 merged PRs)

説明

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.

コントリビューターガイド

調査方針
Javaがprotobufコードでどのようにドキュメントを生成しているかを調べてください。その後、C++とPythonのコードジェネレーターを調べて、同様のドキュメントコピー機能を追加してください。
技術スタック
pythonjava
領域
backendapidocumentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
GitProtocol BuffersCode generation concepts
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65