chore: add custom documentation to the README #313
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
googlebot
added
the
cla: yes
ofrobots
approved these changes
Feb 12, 2019
README.md
Outdated
| @@ -83,6 +116,247 @@ has instructions for running the samples. | |||
| | --------------------------- | --------------------------------- | | |||
| | Examples | [source code](https://github.com/googleapis/nodejs-error-reporting/blob/master/samples/snippets.js) | | |||
|
|
|||
| ## Configuration | |||
|
|
|||
| The following code snippet lists all available configuration options. All configuration options are optional. | |||
There was a problem hiding this comment.
all is probably too strong. I think there are other options that the Service parent class accepts that we simply pass on.
ofrobots
suggested changes
Feb 12, 2019
There was a problem hiding this comment.
Given this comment from @JustinBeckwith, please get his LGTM before landing: #190 (comment)
Codecov Report
@@ Coverage Diff @@
## master #313 +/- ##
======================================
Coverage 96.1% 96.1%
======================================
Files 34 34
Lines 1695 1695
Branches 76 76
======================================
Hits 1629 1629
Misses 49 49
Partials 17 17Continue to review full report at Codecov.
|
JustinBeckwith
approved these changes
Feb 12, 2019
|
It's all good. Thanks for sticking with me on this one. We can re-eval this when we need to do the fancy README gen tool. |
|
@JustinBeckwith Awesome thanks. |
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.
No description provided.