Skip to content

use tick for json string; add test examples#1

Open
zamicol wants to merge 6 commits intoake-persson:masterfrom
zamicol:master
Open

use tick for json string; add test examples#1
zamicol wants to merge 6 commits intoake-persson:masterfrom
zamicol:master

Conversation

@zamicol
Copy link
Copy Markdown

@zamicol zamicol commented Jun 13, 2022

No description provided.

@ake-persson
Copy link
Copy Markdown
Owner

Sry, I missed this pull request. I will have a look this weekend.

Comment thread mapslice_test.go
Comment thread mapslice_test.go Outdated
}
}

func ExampleMapSlice_MarshalJSON() {
Copy link
Copy Markdown
Owner

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.

Copy link
Copy Markdown
Author

@zamicol zamicol Jul 22, 2022

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

Copy link
Copy Markdown
Owner

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.

Copy link
Copy Markdown
Owner

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.

Copy link
Copy Markdown
Author

@zamicol zamicol Jul 25, 2022

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.

Copy link
Copy Markdown
Author

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. 👍

Comment thread mapslice_test.go Outdated
Comment thread mapslice_test.go Outdated
Comment thread mapslice_test.go Outdated
Comment thread mapslice_test.go Outdated
Comment thread mapslice_test.go Outdated
@zamicol zamicol requested a review from ake-persson July 22, 2022 20:58
@zamicol
Copy link
Copy Markdown
Author

zamicol commented Aug 18, 2022

Any word?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants