Clarify that lookup/resolve/descriptor are singleton class methods #174
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Ruby documentation uses `#` exclusively to mean "an instance method," for example [in the Array documentation](https://docs.ruby-lang.org/en/master/Array.html). 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.
|
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. |
|
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. |
|
Thanks for the PR! I incorporated the changes upstream (this repo is currently output-only), and they published this morning. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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::SomeEnumbrings the example more in line with the rest of the examples which all operate on a hypothetical enum module.