Ruby class documentation barely exists
#21.092 aberto em 4 de abr. de 2025
Métricas do repositório
- Stars
- (71.223 estrelas)
- Métricas de merge de PR
- (Mesclagem média 2d 11h) (185 fundiu PRs em 30d)
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:
- https://pkg.go.dev/github.com/golang/protobuf/proto#Message
- https://googleapis.dev/python/protobuf/latest/google/protobuf/message.html
- https://www.javadoc.io/doc/com.google.protobuf/protobuf-java/latest/com/google/protobuf/Message.html
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?