protocolbuffers/protobuf

Ruby class documentation barely exists

Open

#21,092 建立於 2025年4月4日

在 GitHub 查看
 (6 留言) (1 反應) (0 負責人)C++ (16,128 fork)batch import
documentationhelp wantedruby

倉庫指標

Star
 (71,223 star)
PR 合併指標
 (平均合併 2天 11小時) (30 天內合併 185 個 PR)

描述

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?

貢獻者指南