protocolbuffers / protocolbuffers/protobuf

Ruby class documentation barely exists

Open
#21,092 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted ruby
Dominant language
C++
Stars
72k
Forks
16.3k
Avg merge
1d 17h
Merged PRs (30d)
140

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the google-protobuf Ruby gem documentation and the missing Message class entry, then compare its coverage with the linked Go, Python, and Java documentation. Investigate whether YARD comments or another documented approach can represent the C-generated methods without changing them. Done means the Ruby documentation exposes the Message class and its relevant fields and methods.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.