Provide godoc examples for using the api #630
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
Closes prometheus#194 Signed-off-by: Chris Marchbanks <csmarchbanks@gmail.com>
| if len(warnings) > 0 { | ||
| fmt.Printf("Warnings: %v\n", warnings) | ||
| } | ||
| fmt.Printf("Result:\n%v\n", result) |
There was a problem hiding this comment.
wondering whether it is a good idea to add a comment for the exepcted output like in the examples:
https://blog.golang.org/examples
// Output: golly
There was a problem hiding this comment.
I considered having an Output section, but we don't know exactly what the Output would be, and if it is wrong the tests will fail.
We could make a mock Prometheus, where we know the response, but I agree with your comment below that the example would be a bit strange in that case.
|
LGTM |
beorn7
approved these changes
Aug 9, 2019
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.
Closes #194
cc: @krasi-georgiev