protocolbuffers / protocolbuffers.github.io

Other
38 stars 107 forks source link

Clarify that lookup/resolve/descriptor are singleton class methods #174

Closed jez closed 3 weeks ago

jez commented 1 month ago

The Ruby documentation uses # exclusively to mean "an instance method," for example in the Array documentation, making its usage here in the protobuf docs misleading: using # here makes it seem like you're supposed to call this method on instances of the enum module, but there are none.

In general, writing it like this in terms of Foo::SomeEnum brings the example more in line with the rest of the examples which all operate on a hypothetical enum module.

google-cla[bot] commented 1 month ago

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Logofile commented 1 month ago

Thanks for the submission. I'm running it past our Ruby person to confirm, and will roll it into the docs once I get that.

Logofile commented 3 weeks ago

Thanks for the PR! I incorporated the changes upstream (this repo is currently output-only), and they published this morning.