-
Notifications
You must be signed in to change notification settings - Fork 8
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.
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
use tick for json string; add test examples #1
base: master
Are you sure you want to change the base?
Conversation
Sry, I missed this pull request. I will have a look this weekend. |
mapslice_test.go
Outdated
@@ -50,3 +50,33 @@ func TestUnmarshal(t *testing.T) { | |||
t.Errorf("expected: %s\ngot: %s", e, r) | |||
} | |||
} | |||
|
|||
func ExampleMapSlice_MarshalJSON() { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put these in a separate test file with package mapslice_test
that way you would have to import mapslice
. This would serve better as an example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For Go, I think this is fairly idiomatic, and the example will show in the doc. https://go.dev/blog/examples
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a nitpick but consider a beginner that want to copy/paste it won't work out of the box.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with not doing it just giving you the reason I mentioned it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll include a Go playground link in the README with a copy/pasteable example with the same example that's in the README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ake-persson, I came across something from Joe Tsai that is what I think you wanted. I removed the _example
folder, and created file example_test.go
, with package mapslice_test
. The tests will appear in the docs and they import package mapslice-json
as requested.
I think that covers everything. 👍
Any word? |
No description provided.