Add overviews to the examples (#3)

example_create_test.go

@@ -9,6 +9,7 @@ import (
 	paddle "github.com/PaddleHQ/paddle-go-sdk"
 )
 
+// Demonstrates how to create a new entity.
 func Example_create() {
 	// Create a mock HTTP server for this example - skip over this bit!
 	s := mockServerForExample(mockServerResponse{stub: &stub{paths: []stubPath{transaction}}})

example_get_test.go

@@ -8,6 +8,7 @@ import (
 	paddle "github.com/PaddleHQ/paddle-go-sdk"
 )
 
+// Demonstrates how to get an existing entity.
 func Example_get() {
 	// Create a mock HTTP server for this example - skip over this bit!
 	s := mockServerForExample(mockServerResponse{stub: &stub{paths: []stubPath{transaction}}})

example_list_test.go

@@ -8,6 +8,7 @@ import (
 	paddle "github.com/PaddleHQ/paddle-go-sdk"
 )
 
+// Demonstrates how to fetch a list and iterate over the provided results.
 func Example_list() {
 	// Create a mock HTTP server for this example - skip over this bit!
 	s := mockServerForExample(mockServerResponse{stub: &stub{paths: []stubPath{transactions}}})
@@ -46,7 +47,8 @@ func Example_list() {
 	//<nil>
 }
 
-func Example_list_paginate() {
+// Demonstrates how to fetch a list and iterate over the provided results, including the automatic pagination.
+func Example_pagination() {
 	// Create a mock HTTP server for this example - skip over this bit!
 	s := mockServerForExample(mockServerResponse{stub: &stub{paths: []stubPath{
 		transactionsPaginatedPg1,

example_update_test.go

@@ -8,6 +8,7 @@ import (
 	paddle "github.com/PaddleHQ/paddle-go-sdk"
 )
 
+// Demonstrates how to update an existing entity.
 func Example_update() {
 	// Create a mock HTTP server for this example - skip over this bit!
 	s := mockServerForExample(mockServerResponse{stub: &stub{paths: []stubPath{transaction}}})

example_webhook_verifier_test.go

@@ -17,6 +17,7 @@ const (
 	exampleSecretKey = `pdl_ntfset_01hsdn8d43dt7mezr1ef2jtbaw_hKkRiCGyyRhbFwIUuqiTBgI7gnWoV0Gr`
 )
 
+// Demonstrates how to verify a webhook.
 func ExampleWebhookVerifier_Verify() {
 	// Create a WebhookVerifier with your secret key
 	// You should keep your secret outside the src, e.g. as an env variable
@@ -82,6 +83,7 @@ func ExampleWebhookVerifier_Verify() {
 	// Output: {"success": true} <nil>
 }
 
+// Demonstrates how to use the WebhookVerifier as a middleware.
 func ExampleWebhookVerifier_Middleware() {
 	// Create a WebhookVerifier with your secret key
 	// You should keep your secret outside the src, e.g. as an env variable