protocolbuffers/protobuf

Ruby class documentation barely exists

开放

#21,092 创建于 2025年4月4日

 (6 条评论) (1 个反应) (0 位负责人)C++ (16,128 个派生)batch import
documentationhelp wantedruby

仓库指标

星标
 (71,223 个星标)
PR 合并指标
 (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?

贡献者指南