protocolbuffers/protobuf

Ruby class documentation barely exists

Open

#21,092 opened on 2025年4月4日

GitHub で見る
 (6 comments) (1 reaction) (0 assignees)C++ (71,223 stars) (16,128 forks)batch import
documentationhelp wantedruby

説明

What language does this apply to? Ruby

Describe the problem you are trying to solve.

Currently, languages like Golang provide full documentation on fields and methods for Protobuf objects:

The Ruby documentation https://www.rubydoc.info/gems/google-protobuf is extremely bare-bones and doesn't include any of the C-generated methods - there isn't even an entry for the Message class.

Describe the solution you'd like

I can definitely help with generating documentation via YARD comments. YARD allows you to make "fake" methods so it shouldn't affect the C-generated methods. There are other options of course, but that might be the one with the least lift.

Is this something that the team would be interested in accepting?

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

技術スタック
ruby
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
RubyYARDProtocol Buffers
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
Examine the protobuf Ruby source code in the repository (likely under ruby/ directory) to identify the C generated methods that lack documentation. Research YARD's features for documenting C extensions, particularly the `@!method` directive for creating fake method signatures. Review existing documentation at rubydoc.info/gems/google protobuf to understand the current gaps. Check issue comments for any maintainer guidance on preferred documentation approach.
Ruby class documentation barely exists · protocolbuffers/protobuf#21092 | Good First Issue