Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates. #558

Merged
merged 3 commits into from
Sep 26, 2018
Merged

Documentation updates. #558

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1a74ca
Add a jsdoc @deprecated for grpc.load.
nicolasnoble Sep 26, 2018
41c840d
Add a link to protobufjs' documentation.
nicolasnoble Sep 26, 2018
696aafe
s/usage/features/
nicolasnoble Sep 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/grpc-native-core/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ var loadObject = exports.loadObject;

/**
* Load a gRPC object from a .proto file.
* @deprecated Use the {@link https://www.npmjs.com/package/@grpc/proto-loader|proto-loader module}
with grpc.loadPackageDefinition instead.
* @memberof grpc
* @alias grpc.load
* @param {string|{root: string, file: string}} filename The file to load
Expand Down Expand Up @@ -376,4 +378,4 @@ exports.Channel = grpc.Channel;
* {@link grpc.propagate} that indicates what information to propagate
* from parentCall
* @return {grpc~Call}
*/
*/
2 changes: 2 additions & 0 deletions packages/grpc-protobufjs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its features, maybe?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "features and limitations" would work here.


## Installation

Expand Down