Add Readme example to example_test.go #298
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
hoani
force-pushed
the
master
branch
6 times, most recently
from
37d96c0 to
11949bb
Compare
Codecov Report
@@ Coverage Diff @@
## master #298 +/- ##
=======================================
Coverage 92.52% 92.52%
=======================================
Files 22 22
Lines 669 669
=======================================
Hits 619 619
Misses 37 37
Partials 13 13 |
sashabaranov
reviewed
May 4, 2023
.golangci.yml
Outdated
| @@ -9,6 +9,9 @@ run: | |||
| # Default: 1m | |||
| timeout: 3m | |||
|
|
|||
| skip-files: | |||
| - example_test.go | |||
There was a problem hiding this comment.
what exactly do we break in this file? Maybe // nolint would be a better fit?
There was a problem hiding this comment.
Good point, I fixed a bunch of issues in example_test - only needed // nolint in one place 😉
sashabaranov
reviewed
May 4, 2023
README.md
Outdated
|
|
||
| ``` | ||
|
|
||
| ### Other examples: |
There was a problem hiding this comment.
Let's not remove examples from the README, as it's easy to reach
|
Great stuff, thank you for the PR! |
hoani
changed the title
sashabaranov
reviewed
May 6, 2023
sashabaranov
approved these changes
May 8, 2023
sashabaranov
approved these changes
May 8, 2023
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.
Moves the
READMEexamples toexample_test.gowhich improves the go docs:(from a local run)
I also added executable examples under an
examplefolder. This works pretty well and I suspect is what most people will end up referring to when they first start using thego-openaipackage:I've removed the examples from the
README.md- but happy to put them back...Kind of relates to #80 - but really these examples aren't really testable. The purpose of this package is to interact with external AI APIs... which to be fair is never going to have deterministic results 😅