Documentation updates. #558
Merged
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
murgatroid99
approved these changes
Sep 26, 2018
packages/grpc-protobufjs/README.md
Outdated
| @@ -1,6 +1,8 @@ | |||
| # gRPC Protobuf Loader | |||
|
|
|||
| A utility package for loading `.proto` files for use with gRPC, using the latest Protobuf.js package. | |||
| Please refer to [protobuf.js' documentation](https://github.com/dcodeIO/protobuf.js/blob/master/README.md) | |||
| to understands its usage and limitations. | |||
There was a problem hiding this comment.
I'm not sure about pointing to Protobuf.js for "usage". The usage of this library is defined in this documentation, not in the Protobuf.js documentation.
There was a problem hiding this comment.
I wanted to say something of the ilk of "pros and cons", but since we don't have any comparison point, I'm not sure this idiom would be appropriate. Any suggestion ?
There was a problem hiding this comment.
Its features, maybe?
There was a problem hiding this comment.
I think "features and limitations" would work here.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Addresses concerns from #556.