Add documentation #35
Merged
Conversation
This file contains hidden or 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
bufdev
reviewed
Apr 28, 2022
| or TypeScript declaration files. | ||
|
|
||
| Possible values: | ||
| - `target=js` - generates a `_pb.js` file for every `.proto` input file. |
Member
There was a problem hiding this comment.
Should these be separate plugins?
bufdev
reviewed
Apr 28, 2022
| - `ts_nocheck=false` - do not print the annotation. | ||
|
|
||
|
|
||
| ### `eslint_disable` |
Member
There was a problem hiding this comment.
Do we want to expose this option?
Member
Author
There was a problem hiding this comment.
I think we can unexpose, same with the other option. Tracking in #53
bufdev
reviewed
Apr 28, 2022
| `target=ts`. | ||
|
|
||
|
|
||
| ### `ts_nocheck` |
Member
There was a problem hiding this comment.
Could we get away with not exposing this option?
bufdev
approved these changes
Apr 28, 2022
Member
bufdev
left a comment
bufdev
left a comment
There was a problem hiding this comment.
I think we merge this as-is and iterate from there.
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.
This is the first stab at documentation for the library and code generator. To keep things simple, basically the entire documentation is in the top-level README.md.
The docs are structured a bit similar to the protocol buffer language references (see Java). We go through each protobuf type and show what it's looked like when compiled by us. Then there is a separate section for API docs.
There is also a code example based on the examples in the protobuf repository that can be run without having to install any tooling, so it's easy to get started.